Struct numcodecs_python::PyCodecClassAdapter

pub struct PyCodecClassAdapter { /* private fields */ }

Wrapper around PyCodecClasses to use the DynCodecType API.

Implementations

impl PyCodecClassAdapter

pub fn from_codec_class(class: Bound<'_, PyCodecClass>) -> Result<Self, PyErr>

Wraps a PyCodecClass to use the DynCodecType API.

Errors

Errors if the codec class does not provide an identifier.

pub fn as_codec_class<'py>(&self, py: Python<'py>) -> &Bound<'py, PyCodecClass>

Access the wrapped PyCodecClass to use its PyCodecClassMethods API.

pub fn into_codec_class(self, py: Python<'_>) -> Bound<'_, PyCodecClass>

Unwrap the PyCodecClass to use its PyCodecClassMethods API.

pub fn with_downcast<T: DynCodecType, O>( class: &Bound<'_, PyCodecClass>, with: impl for<'a> FnOnce(&'a T) -> O, ) -> Option<O>

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

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

Trait Implementations

impl DynCodecType for PyCodecClassAdapter

type Codec = PyCodecAdapter

Type of the instances of this codec type object.

fn codec_id(&self) -> &str

Codec identifier.

fn codec_config_schema(&self) -> Schema

JSON schema for the codec’s configuration.

fn codec_from_config<'de, D: Deserializer<'de>>( &self, config: D, ) -> Result<Self::Codec, D::Error>

Instantiate a codec of this type from a serialized configuration.