Skip to main content

AnyChunk

Enum AnyChunk 

Source
pub enum AnyChunk<const BODY_SIZE: usize = DEFAULT_BODY_SIZE> {
    Content(ContentChunk<BODY_SIZE>),
    SingleOwner(SingleOwnerChunk<BODY_SIZE>),
    Custom {
        type_id: ChunkTypeId,
        address: ChunkAddress,
        data: Bytes,
    },
}
Expand description

Type-erased chunk for runtime polymorphism with configurable body size.

This enum provides dynamic dispatch for chunks without requiring object-safe traits. Use this when you need to store heterogeneous chunk types in collections or pass chunks through interfaces that can’t be generic.

§Why an enum instead of Box<dyn Chunk>?

The Chunk trait has an associated type (type Header) which makes it not object-safe. This enum provides the same functionality while maintaining type safety.

§Examples

use nectar_primitives::{AnyChunk, Chunk, ContentChunk, ChunkTypeId};

// Create a content chunk
let content = ContentChunk::new(&b"hello world"[..]).unwrap();
let any: AnyChunk = content.clone().into();

// Access common properties
assert_eq!(any.type_id(), ChunkTypeId::CONTENT);

// Get the concrete type back
if let Some(recovered) = any.as_content() {
    assert_eq!(recovered.address(), content.address());
}

Variants§

§

Content(ContentChunk<BODY_SIZE>)

A content-addressed chunk (CAC).

§

SingleOwner(SingleOwnerChunk<BODY_SIZE>)

A single-owner chunk (SOC).

§

Custom

A custom chunk type (for extensibility).

This variant allows storing chunks of types not known at compile time. The raw bytes are preserved for potential later processing.

Fields

§type_id: ChunkTypeId

The chunk type identifier.

§address: ChunkAddress

The chunk’s address.

§data: Bytes

The raw chunk data.

Implementations§

Source§

impl<const BODY_SIZE: usize> AnyChunk<BODY_SIZE>

Source

pub fn address(&self) -> &ChunkAddress

Get the address of this chunk.

Source

pub fn data(&self) -> &Bytes

Get the raw data contained in this chunk.

Source

pub const fn type_id(&self) -> ChunkTypeId

Get the type ID of this chunk.

Source

pub fn size(&self) -> usize

Get the total size of this chunk in bytes.

Source

pub fn span(&self) -> u64

Get the span (logical data length) of this chunk.

For content chunks and single-owner chunks, this returns the BMT span. For custom chunks, the span is not available (returns 0).

Source

pub fn verify(&self, expected: &ChunkAddress) -> Result<()>

Verify that this chunk’s address matches an expected address.

Source

pub fn into_bytes(self) -> Bytes

Convert this chunk into its serialized bytes representation.

Source

pub fn is<T: ChunkType>(&self) -> bool

Check if this chunk is of a specific type.

Source

pub const fn is_content(&self) -> bool

Check if this is a content chunk.

Source

pub const fn is_single_owner(&self) -> bool

Check if this is a single-owner chunk.

Source

pub const fn is_custom(&self) -> bool

Check if this is a custom chunk type.

Source

pub const fn as_content(&self) -> Option<&ContentChunk<BODY_SIZE>>

Get a reference to the contained ContentChunk, if this is one.

Source

pub const fn as_single_owner(&self) -> Option<&SingleOwnerChunk<BODY_SIZE>>

Get a reference to the contained SingleOwnerChunk, if this is one.

Source

pub fn into_content(self) -> Option<ContentChunk<BODY_SIZE>>

Convert into the contained ContentChunk, if this is one.

Source

pub fn into_single_owner(self) -> Option<SingleOwnerChunk<BODY_SIZE>>

Convert into the contained SingleOwnerChunk, if this is one.

Trait Implementations§

Source§

impl<const BODY_SIZE: usize> Clone for AnyChunk<BODY_SIZE>

Source§

fn clone(&self) -> AnyChunk<BODY_SIZE>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const BODY_SIZE: usize> Debug for AnyChunk<BODY_SIZE>

Source§

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

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

impl<const BODY_SIZE: usize> Eq for AnyChunk<BODY_SIZE>

Source§

impl<const BODY_SIZE: usize> From<ContentChunk<BODY_SIZE>> for AnyChunk<BODY_SIZE>

Source§

fn from(chunk: ContentChunk<BODY_SIZE>) -> Self

Converts to this type from the input type.
Source§

impl<const BODY_SIZE: usize> From<SingleOwnerChunk<BODY_SIZE>> for AnyChunk<BODY_SIZE>

Source§

fn from(chunk: SingleOwnerChunk<BODY_SIZE>) -> Self

Converts to this type from the input type.
Source§

impl<const BODY_SIZE: usize> PartialEq for AnyChunk<BODY_SIZE>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

§

impl<const BODY_SIZE: usize = DEFAULT_BODY_SIZE> !Freeze for AnyChunk<BODY_SIZE>

§

impl<const BODY_SIZE: usize> RefUnwindSafe for AnyChunk<BODY_SIZE>

§

impl<const BODY_SIZE: usize> Send for AnyChunk<BODY_SIZE>

§

impl<const BODY_SIZE: usize> Sync for AnyChunk<BODY_SIZE>

§

impl<const BODY_SIZE: usize> Unpin for AnyChunk<BODY_SIZE>

§

impl<const BODY_SIZE: usize> UnsafeUnpin for AnyChunk<BODY_SIZE>

§

impl<const BODY_SIZE: usize> UnwindSafe for AnyChunk<BODY_SIZE>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more