Struct bonsaidb::core::arc_bytes::serde::CowBytes

pub struct CowBytes<'a>(pub Cow<'a, [u8]>);

A Cow<'a, [u8]> wrapper that supports serializing efficiently in Serde.

Tuple Fields

0: Cow<'a, [u8]>

Implementations

impl<'a> CowBytes<'a>

pub fn into_cow(self) -> Cow<'a, [u8]>

Returns the underlying Cow.

pub fn into_vec(self) -> Vec<u8>

Returns the underlying Vec inside of the Cow, or clones the borrowed bytes into a new Vec..

pub fn as_slice(&self) -> &[u8]

Returns a slice of the contained data.

Methods from Deref<Target = Cow<'a, [u8]>>

pub fn is_borrowed(&self) -> bool

🔬This is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is borrowed, i.e. if to_mut would require additional work.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow = Cow::Borrowed("moo");
assert!(cow.is_borrowed());

let bull: Cow<'_, str> = Cow::Owned("...moo?".to_string());
assert!(!bull.is_borrowed());

pub fn is_owned(&self) -> bool

🔬This is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is owned, i.e. if to_mut would be a no-op.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow: Cow<'_, str> = Cow::Owned("moo".to_string());
assert!(cow.is_owned());

let bull = Cow::Borrowed("...moo?");
assert!(!bull.is_owned());

pub fn to_mut(&mut self) -> &mut <B as ToOwned>::Owned

Acquires a mutable reference to the owned form of the data.

Clones the data if it is not already owned.

Examples

use std::borrow::Cow;

let mut cow = Cow::Borrowed("foo");
cow.to_mut().make_ascii_uppercase();

assert_eq!(
  cow,
  Cow::Owned(String::from("FOO")) as Cow<'_, str>
);

Trait Implementations

impl<'a> Clone for CowBytes<'a>

fn clone(&self) -> CowBytes<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CowBytes<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CowBytes<'a>

fn default() -> CowBytes<'a>

Returns the “default value” for a type.

impl<'a> Deref for CowBytes<'a>

type Target = Cow<'a, [u8]>

The resulting type after dereferencing.

fn deref(&self) -> &<CowBytes<'a> as Deref>::Target

Dereferences the value.

impl<'a> DerefMut for CowBytes<'a>

fn deref_mut(&mut self) -> &mut <CowBytes<'a> as Deref>::Target

Mutably dereferences the value.

impl<'de, 'a> Deserialize<'de> for CowBytes<'a>

where 'de: 'a,

fn deserialize<D>( deserializer: D ) -> Result<CowBytes<'a>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a [u8]> for CowBytes<'a>

fn from(buffer: &'a [u8]) -> CowBytes<'a>

Converts to this type from the input type.

impl<'a, const N: usize> From<&'a [u8; N]> for CowBytes<'a>

fn from(buffer: &'a [u8; N]) -> CowBytes<'a>

Converts to this type from the input type.

impl<'a, const N: usize> From<[u8; N]> for CowBytes<'a>

fn from(buffer: [u8; N]) -> CowBytes<'a>

Converts to this type from the input type.

impl<'a> From<Bytes> for CowBytes<'a>

fn from(bytes: Bytes) -> CowBytes<'a>

Converts to this type from the input type.

impl<'a> From<CowBytes<'a>> for ArcBytes<'a>

fn from(bytes: CowBytes<'a>) -> ArcBytes<'a>

Converts to this type from the input type.

impl<'a> From<CowBytes<'a>> for Bytes

fn from(bytes: CowBytes<'a>) -> Bytes

Converts to this type from the input type.

impl<'a> From<Vec<u8>> for CowBytes<'a>

fn from(buffer: Vec<u8>) -> CowBytes<'a>

Converts to this type from the input type.

impl<'a> Hash for CowBytes<'a>

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

where __H: Hasher,

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<'a, 'k> IntoPrefixRange<'a, CowBytes<'k>> for CowBytes<'k>

fn to_prefix_range(&'a self) -> RangeRef<'a, CowBytes<'k>>

Returns the value as a prefix-range, which will match all values that start with self.

impl<'k> Key<'k> for CowBytes<'k>

const CAN_OWN_BYTES: bool = true

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<CowBytes<'k>, <CowBytes<'k> as KeyEncoding>::Error>

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

fn first_value() -> Result<Self, NextValueError>

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

fn next_value(&self) -> Result<Self, 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> KeyEncoding<CowBytes<'k>> for &'k [u8]

type Error = Infallible

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

const LENGTH: Option<usize> = None

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.

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

Convert self into a Cow<'_, [u8]> containing bytes that are able to be compared via memcmp in a way that is comptaible with its own Ord implementation.

impl<'k> KeyEncoding for CowBytes<'k>

type Error = Infallible

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

const LENGTH: Option<usize> = None

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.

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

Convert self into a Cow<'_, [u8]> containing bytes that are able to be compared via memcmp in a way that is comptaible with its own Ord implementation.

impl<'a> Ord for CowBytes<'a>

fn cmp(&self, other: &CowBytes<'a>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<'a, 'b> PartialEq<&'b [u8]> for CowBytes<'a>

fn eq(&self, other: &&'b [u8]) -> bool

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

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<'a, 'b, const N: usize> PartialEq<&'b [u8; N]> for CowBytes<'a>

fn eq(&self, other: &&'b [u8; N]) -> bool

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

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<'a> PartialEq<[u8]> for CowBytes<'a>

fn eq(&self, other: &[u8]) -> bool

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

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<'a, const SIZE: usize> PartialEq<[u8; SIZE]> for CowBytes<'a>

fn eq(&self, other: &[u8; SIZE]) -> bool

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

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<'a> PartialEq for CowBytes<'a>

fn eq(&self, other: &CowBytes<'a>) -> bool

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

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<'b, 'a> PartialOrd<&'b [u8]> for CowBytes<'a>

fn partial_cmp(&self, other: &&'b [u8]) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, 'b, const SIZE: usize> PartialOrd<&'b [u8; SIZE]> for CowBytes<'a>

fn partial_cmp(&self, other: &&'b [u8; SIZE]) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<[u8]> for CowBytes<'a>

fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd for CowBytes<'a>

fn partial_cmp(&self, other: &CowBytes<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Serialize for CowBytes<'a>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for CowBytes<'a>

impl<'a> StructuralEq for CowBytes<'a>

impl<'a> StructuralPartialEq for CowBytes<'a>