numcodecs_python

Struct PyCodecAdapter

Source
pub struct PyCodecAdapter { /* private fields */ }
Expand description

Wrapper around PyCodecs to use the Codec API.

Implementations§

Source§

impl PyCodecAdapter

Source

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.

Source

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.

Source

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

Access the wrapped PyCodec to use its PyCodecMethods API.

Source

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

Unwrap the PyCodec to use its PyCodecMethods API.

Source

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.

Source

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§

Source§

impl Clone for PyCodecAdapter

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Codec for PyCodecAdapter

Source§

type Error = PyErr

Error type that may be returned during encodeing and decodeing.
Source§

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

Encodes the data and returns the result. Read more
Source§

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

Decodes the encoded data and returns the result. Read more
Source§

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

Decodes the encoded data and writes the result into the provided decoded output. Read more
Source§

impl DynCodec for PyCodecAdapter

Source§

type Type = PyCodecClassAdapter

Type object type for this codec.
Source§

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

Returns the type object for this codec.
Source§

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

Serializes the configuration parameters for this codec. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Ungil for T
where T: Send,