Struct bonsaidb::core::key::OptionKeyV1

pub struct OptionKeyV1<T>(pub Option<T>);

👎Deprecated: this type should not be used in new code and should only be used in transitionary code.

Expand description

A type that preserves the original implementation of Key for Option<T>. This should not be used in new code and will be removed in a future version.

Tuple Fields§

§0: Option<T>

👎Deprecated: this type should not be used in new code and should only be used in transitionary code.

Trait Implementations§

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

fn clone(&self) -> OptionKeyV1<T>

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

impl<T> Debug for OptionKeyV1<T>
where T: Debug,

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

Formats the value using the given formatter. Read more

impl<'k, T> Key<'k> for OptionKeyV1<T>
where T: Key<'k>, OptionKeyV1<T>: KeyEncoding<Error = <T as KeyEncoding>::Error>,

const CAN_OWN_BYTES: bool = false

If true, this type can benefit from an owned Vec<u8>. This flag is used as a hint of whether to attempt to do memcpy operations in some decoding operations to avoid extra allocations.

fn from_ord_bytes<'b>( bytes: ByteSource<'k, 'b> ) -> Result<OptionKeyV1<T>, <OptionKeyV1<T> as KeyEncoding>::Error>

Deserialize a sequence of bytes previously encoded with KeyEncoding::as_ord_bytes.

fn first_value() -> Result<OptionKeyV1<T>, NextValueError>

Return the first value in sequence for this type. Not all types implement this.

fn next_value(&self) -> Result<OptionKeyV1<T>, NextValueError>

Return the next value in sequence for this type. Not all types implement this. Instead of wrapping/overflowing, None should be returned.

impl<K, T> KeyEncoding<OptionKeyV1<K>> for OptionKeyV1<T>
where T: KeyEncoding<K>, K: for<'k> Key<'k>,

fn as_ord_bytes( &self ) -> Result<Cow<'_, [u8]>, <OptionKeyV1<T> as KeyEncoding<OptionKeyV1<K>>>::Error>

Panics

Panics if T::into_big_endian_bytes returns an empty IVec

type Error = <T as KeyEncoding<K>>::Error

The error type that can be produced by either serialization or deserialization.

const LENGTH: Option<usize> = T::LENGTH

The size of the key, if constant. If this type doesn’t produce the same number of bytes for each value, this should be None.

fn describe<Visitor>(visitor: &mut Visitor)
where Visitor: KeyVisitor,

Describes this type by invoking functions on visitor describing the key being encoded. Read more

impl<T> PartialEq for OptionKeyV1<T>
where T: PartialEq,

fn eq(&self, other: &OptionKeyV1<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

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

impl<T> Copy for OptionKeyV1<T>
where T: Copy,

impl<T> Eq for OptionKeyV1<T>
where T: Eq,

impl<T> StructuralEq for OptionKeyV1<T>

impl<T> StructuralPartialEq for OptionKeyV1<T>

Auto Trait Implementations§

impl<T> RefUnwindSafe for OptionKeyV1<T>
where T: RefUnwindSafe,

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

impl<T> Sync for OptionKeyV1<T>
where T: Sync,

impl<T> Unpin for OptionKeyV1<T>
where T: Unpin,

impl<T> UnwindSafe for OptionKeyV1<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsOut<T> for T
where T: Copy,

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

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

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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