Struct Orphan 

pub struct Orphan<T> { /* private fields */ }

A container for a single, non-collection value stored on disk.

Orphan is suitable for storing simple data types like integers, enums, etc.

Implementations

impl<T> Orphan<T>

where T: ValueEnDe,

pub unsafe fn shadow(&self) -> Self

Creates a “shadow” copy of the Orphan instance.

Safety

This API breaks Rust’s semantic safety guarantees. Use only in a race-free environment.

pub unsafe fn from_bytes(s: impl AsRef<[u8]>) -> Self

Creates an Orphan from a byte slice.

Safety

This function is unsafe and assumes the byte slice is a valid representation.

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

Returns the byte representation of the Orphan.

pub fn new(v: T) -> Self

Creates a new Orphan with an initial value.

pub fn get_value(&self) -> T

Retrieves a clone of the inner value.

pub fn set_value(&mut self, v: &T)

Sets the inner value.

pub fn is_uninitialized(&self) -> bool

Checks if the Orphan is uninitialized.

pub fn initialize_if_empty(&mut self, v: T)

Initializes the Orphan with a value if it is currently empty.

pub fn get_mut(&mut self) -> ValueMut<'_, T>

Retrieves a mutable handler for the value.

This is the recommended way to modify the value.

Example

let mut o = Orphan::new(10);
*o.get_mut() = 20;
assert_eq!(o.get_value(), 20);

pub fn is_the_same_instance(&self, other_hdr: &Self) -> bool

Checks if this Orphan instance is the same as another.

Trait Implementations

impl<T> Add<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Add<Output = T>,

type Output = T

The resulting type after applying the + operator.

fn add(self, other: T) -> Self::Output

Performs the + operation.

impl<T> Add for Orphan<T>

where T: ValueEnDe + Ord + Eq + Add<Output = T>,

type Output = T

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<T> AddAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + AddAssign,

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T> AddAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + AddAssign,

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T> BitAnd<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitAnd<Output = T>,

type Output = T

The resulting type after applying the & operator.

fn bitand(self, other: T) -> Self::Output

Performs the & operation.

impl<T> BitAnd for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitAnd<Output = T>,

type Output = T

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl<T> BitAndAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitAndAssign,

fn bitand_assign(&mut self, other: T)

Performs the &= operation.

impl<T> BitAndAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitAndAssign,

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl<T> BitOr<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitOr<Output = T>,

type Output = T

The resulting type after applying the | operator.

fn bitor(self, other: T) -> Self::Output

Performs the | operation.

impl<T> BitOr for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitOr<Output = T>,

type Output = T

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl<T> BitOrAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitOrAssign,

fn bitor_assign(&mut self, other: T)

Performs the |= operation.

impl<T> BitOrAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitOrAssign,

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl<T> BitXor<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitXor<Output = T>,

type Output = T

The resulting type after applying the ^ operator.

fn bitxor(self, other: T) -> Self::Output

Performs the ^ operation.

impl<T> BitXor for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitXor<Output = T>,

type Output = T

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self::Output

Performs the ^ operation.

impl<T> BitXorAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitXorAssign,

fn bitxor_assign(&mut self, other: T)

Performs the ^= operation.

impl<T> BitXorAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + BitXorAssign,

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl<T> Clone for Orphan<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Orphan<T>

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

Formats the value using the given formatter.

impl<T: Default + ValueEnDe> Default for Orphan<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Orphan<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Div<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Div<Output = T>,

type Output = T

The resulting type after applying the / operator.

fn div(self, other: T) -> Self::Output

Performs the / operation.

impl<T> Div for Orphan<T>

where T: ValueEnDe + Ord + Eq + Div<Output = T>,

type Output = T

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + DivAssign,

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T> DivAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + DivAssign,

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T> Mul<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Mul<Output = T>,

type Output = T

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self::Output

Performs the * operation.

impl<T> Mul for Orphan<T>

where T: ValueEnDe + Ord + Eq + Mul<Output = T>,

type Output = T

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + MulAssign,

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T> MulAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + MulAssign,

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T> Neg for Orphan<T>

where T: ValueEnDe + Ord + Eq + Neg<Output = T>,

type Output = T

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T> Not for Orphan<T>

where T: ValueEnDe + Ord + Eq + Not<Output = T>,

type Output = T

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T> Ord for Orphan<T>

where T: ValueEnDe + Ord,

fn cmp(&self, other: &Self) -> 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<T> PartialEq<T> for Orphan<T>

where T: ValueEnDe + PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq for Orphan<T>

where T: ValueEnDe + PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd<T> for Orphan<T>

where T: ValueEnDe + Ord,

fn partial_cmp(&self, other: &T) -> 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<T> PartialOrd for Orphan<T>

where T: ValueEnDe + Ord,

fn partial_cmp(&self, other: &Self) -> 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<T> Rem<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Rem<Output = T>,

type Output = T

The resulting type after applying the % operator.

fn rem(self, other: T) -> Self::Output

Performs the % operation.

impl<T> Rem for Orphan<T>

where T: ValueEnDe + Ord + Eq + Rem<Output = T>,

type Output = T

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self::Output

Performs the % operation.

impl<T> RemAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + RemAssign,

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T> RemAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + RemAssign,

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<T> Serialize for Orphan<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Shl<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Shl<Output = T>,

type Output = T

The resulting type after applying the << operator.

fn shl(self, other: T) -> Self::Output

Performs the << operation.

impl<T> Shl for Orphan<T>

where T: ValueEnDe + Ord + Eq + Shl<Output = T>,

type Output = T

The resulting type after applying the << operator.

fn shl(self, other: Self) -> Self::Output

Performs the << operation.

impl<T> ShlAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + ShlAssign,

fn shl_assign(&mut self, other: T)

Performs the <<= operation.

impl<T> ShlAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + ShlAssign,

fn shl_assign(&mut self, other: Self)

Performs the <<= operation.

impl<T> Shr<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Shr<Output = T>,

type Output = T

The resulting type after applying the >> operator.

fn shr(self, other: T) -> Self::Output

Performs the >> operation.

impl<T> Shr for Orphan<T>

where T: ValueEnDe + Ord + Eq + Shr<Output = T>,

type Output = T

The resulting type after applying the >> operator.

fn shr(self, other: Self) -> Self::Output

Performs the >> operation.

impl<T> ShrAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + ShrAssign,

fn shr_assign(&mut self, other: T)

Performs the >>= operation.

impl<T> ShrAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + ShrAssign,

fn shr_assign(&mut self, other: Self)

Performs the >>= operation.

impl<T> Sub<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + Sub<Output = T>,

type Output = T

The resulting type after applying the - operator.

fn sub(self, other: T) -> Self::Output

Performs the - operation.

impl<T> Sub for Orphan<T>

where T: ValueEnDe + Ord + Eq + Sub<Output = T>,

type Output = T

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<T> SubAssign<T> for Orphan<T>

where T: ValueEnDe + Ord + Eq + SubAssign,

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T> SubAssign for Orphan<T>

where T: ValueEnDe + Ord + Eq + SubAssign,

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T> Eq for Orphan<T>

where T: ValueEnDe + PartialEq,