Struct ReinterpretCodec

pub struct ReinterpretCodec { /* private fields */ }

Codec to reinterpret data between different compatible types.

Note that no conversion happens, only the meaning of the bits changes.

Reinterpreting to bytes, or to a same-sized unsigned integer type, or without the changing the dtype are supported.

Implementations

impl ReinterpretCodec

pub fn try_new( encode_dtype: AnyArrayDType, decode_dtype: AnyArrayDType, ) -> Result<Self, ReinterpretCodecError>

Try to create a ReinterpretCodec that reinterprets the input data from decode_dtype to encode_dtype on encoding, and from encode_dtype back to decode_dtype on decoding.

Errors

Errors with ReinterpretCodecError::InvalidReinterpret if encode_dtype and decode_dtype are incompatible.

pub const fn passthrough(dtype: AnyArrayDType) -> Self

Create a ReinterpretCodec that does not change the dtype.

pub const fn to_bytes(dtype: AnyArrayDType) -> Self

Create a ReinterpretCodec that reinterprets dtype as bytes.

pub const fn to_binary(dtype: AnyArrayDType) -> Self

Create a ReinterpretCodec that reinterprets dtype as its binary equivalent.

Trait Implementations

impl Clone for ReinterpretCodec

fn clone(&self) -> ReinterpretCodec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Codec for ReinterpretCodec

type Error = ReinterpretCodecError

Error type that may be returned during encodeing and decodeing.

fn encode(&self, data: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Encodes the data and returns the result.

fn decode(&self, encoded: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Decodes the encoded data and returns the result.

fn decode_into( &self, encoded: AnyArrayView<'_>, decoded: AnyArrayViewMut<'_>, ) -> Result<(), Self::Error>

Decodes the encoded data and writes the result into the provided decoded output.

impl<'de> Deserialize<'de> for ReinterpretCodec

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ReinterpretCodec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ReinterpretCodec

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StaticCodec for ReinterpretCodec

const CODEC_ID: &'static str = "reinterpret"

Codec identifier.

type Config<'de> = ReinterpretCodec

Configuration type, from which the codec can be created infallibly.

fn from_config(config: Self::Config<'_>) -> Self

Instantiate a codec from its configuration.

fn get_config(&self) -> StaticCodecConfig<'_, Self>

Get the configuration for this codec.