Struct BoxedSlice 

pub struct BoxedSlice<I, R: ?Sized = [u8]> { /* private fields */ }

An owned, dynamically sized key that satisfies an Invariant.

Implementations

impl<I, R> BoxedSlice<I, R>

where I: Invariant, R: ?Sized + Raw,

pub fn new(key: impl Into<Box<R>>) -> Result<Self, (Box<R>, I::Error)>

Construct a boxed slice after validating.

Returns Ok if the input boxed slice satisfies the invariant.

impl<I, R: ?Sized> BoxedSlice<I, R>

pub const unsafe fn new_unchecked(key: Box<R>) -> Self

Construct a boxed slice without validating.

SAFETY

Caller must guarantee that raw satisfies the invariant, i.e., I::validate(key) would return Ok(()).

pub const fn as_slice(&self) -> &Slice<I, R>

Get a borrowed Slice that preserves the invariant.

pub fn into_boxed_slice(self) -> Box<R>

Get an owned boxed slice.

Trait Implementations

impl<I, R: ?Sized> AsRef<Slice<I, R>> for BoxedSlice<I, R>

fn as_ref(&self) -> &Slice<I, R>

Converts this type into a shared reference of the (usually inferred) input type.

impl<I, R: ?Sized> Borrow<Slice<I, R>> for BoxedSlice<I, R>

fn borrow(&self) -> &Slice<I, R>

Immutably borrows from an owned value.

impl<I, R: ?Sized> Clone for BoxedSlice<I, R>

where Box<R>: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug, R: Debug + ?Sized> Debug for BoxedSlice<I, R>

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

Formats the value using the given formatter.

impl<I, R: ?Sized> Default for BoxedSlice<I, R>

where Box<R>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<I, R: ?Sized> Deref for BoxedSlice<I, R>

type Target = Slice<I, R>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I: Eq, R: Eq + ?Sized> Eq for BoxedSlice<I, R>

impl From<CString> for BoxedSlice<Terminated<0>, [u8]>

fn from(string: CString) -> Self

Converts to this type from the input type.

impl<I: Hash, R: Hash + ?Sized> Hash for BoxedSlice<I, R>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I, R> Key for BoxedSlice<I, R>

where I: Invariant, R: ?Sized + Raw,

type Read<'k> = Reader<'k, <I as Invariant>::Terminate>

Tracks key length and allows extracting edges and slicing key bytes.

type Write = Writer

Constructs a key from an initial reader prefix and sequence of bytes and edges.

type Borrowed = Slice<I, R>

A non-allocated byte sequence that a key can be cheaply borrowed as.

type Insert<'k> = &'k Slice<I, R>

Keys can either have edges that store inline bytes (e.g., u64, BoxedSlice), or pointers (i.e., Slice).

type Edge = Le

Edge metadata.

type Len = Byte

Key length.

fn as_insert(&self) -> Self::Insert<'_>

Convert the key type to the insert type.

fn insert_as_read<'k>(insert: Self::Insert<'k>) -> Self::Read<'k>

where Self: 'k,

Convert the insert type to a reader with appropriate lifetime.

fn insert_to_key<'k>(insert: Self::Insert<'k>) -> Self

where Self: 'k,

Convert the insert type to the key type.

unsafe fn write_as_insert<'k>(writer: &'k Self::Write) -> Self::Insert<'k>

where Self: 'k,

Convert a reference to a writer into the insert type.

impl<I: Ord, R: Ord + ?Sized> Ord for BoxedSlice<I, R>

fn cmp(&self, other: &BoxedSlice<I, R>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<I: PartialEq, R: PartialEq + ?Sized> PartialEq for BoxedSlice<I, R>

fn eq(&self, other: &BoxedSlice<I, R>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<I: PartialOrd, R: PartialOrd + ?Sized> PartialOrd for BoxedSlice<I, R>

fn partial_cmp(&self, other: &BoxedSlice<I, R>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I: PartialEq, R: PartialEq + ?Sized> StructuralPartialEq for BoxedSlice<I, R>