Struct numcodecs_python::PyCodecAdapter

pub struct PyCodecAdapter { /* private fields */ }

Wrapper around PyCodecs to use the Codec API.

Implementations

impl PyCodecAdapter

pub fn from_registry_with_config<'de, D: Deserializer<'de>>( config: D, ) -> Result<Self, D::Error>

Instantiate a codec from the PyCodecRegistry with a serialized configuration.

The config must include the id field with the PyCodecClassMethods::codec_id.

Errors

Errors if no codec with a matching id has been registered, or if constructing the codec fails.

pub fn from_codec(codec: Bound<'_, PyCodec>) -> Result<Self, PyErr>

Wraps a PyCodec to use the Codec API.

Errors

Errors if the codec’s class does not provide an identifier.

pub fn as_codec<'py>(&self, py: Python<'py>) -> &Bound<'py, PyCodec>

Access the wrapped PyCodec to use its PyCodecMethods API.

pub fn into_codec(self, py: Python<'_>) -> Bound<'_, PyCodec>

Unwrap the PyCodec to use its PyCodecMethods API.

pub fn try_clone(&self, py: Python<'_>) -> Result<Self, PyErr>

Try to clone this codec.

Errors

Errors if extracting this codec’s config or creating a new codec from the config fails.

pub fn with_downcast<T: DynCodec, O>( codec: &Bound<'_, PyCodec>, with: impl for<'a> FnOnce(&'a T) -> O, ) -> Option<O>

If codec represents an exported DynCodec T, i.e. its class was initially created with crate::export_codec_class, the with closure provides access to the instance of type T.

If codec is not an instance of T, the with closure is not run and None is returned.

Trait Implementations

impl Clone for PyCodecAdapter

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for PyCodecAdapter

type Error = PyErr

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 DynCodec for PyCodecAdapter

type Type = PyCodecClassAdapter

Type object type for this codec.

fn ty(&self) -> Self::Type

Returns the type object for this codec.

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

Serializes the configuration parameters for this codec.