Skip to main content

CodecRegistry

Struct CodecRegistry 

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

Process-wide registry of codecs, keyed by codec id.

Implementations§

Source§

impl CodecRegistry

Source

pub fn new() -> Self

Construct an empty registry.

Source

pub fn register(&mut self, codec: Box<dyn Codec>)

Register a codec. Id collisions are rejected at runtime — two codecs claiming the same id is a programming error, not a recoverable condition.

§Panics

Panics if a codec with the same id is already registered.

Source

pub fn compress(&self, id: u8, plaintext: &[u8]) -> Result<Vec<u8>, CoreError>

Dispatch compression to the codec identified by id.

§Errors

Returns CoreError::UnsupportedFeature if no codec with id is registered.

Source

pub fn decompress( &self, id: u8, compressed: &[u8], expected_len: u32, ) -> Result<Vec<u8>, CoreError>

Dispatch decompression to the codec identified by id.

§Errors

Returns CoreError::UnsupportedFeature if no codec with id is registered, or CoreError::Corrupt if decompression fails.

Source

pub fn compress_with_tunables( &self, id: u8, plaintext: &[u8], tunables: &CodecTunables, ) -> Result<Vec<u8>, CoreError>

Dispatch compression with a tunables hint. Codecs that don’t override the trait method fall through to plain compress.

§Errors

Same as CodecRegistry::compress.

Source§

impl CodecRegistry

Source

pub fn codec_name(&self, codec_id: u8) -> Option<&'static str>

Human-readable name for a registered codec id.

Trait Implementations§

Source§

impl Debug for CodecRegistry

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CodecRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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.