Struct someday::Commit

pub struct Commit<T: Clone> {
    pub timestamp: Timestamp,
    pub data: T,
}

Owned snapshot of some data T and its Timestamp

This is a Commit of data received from the operations like Writer::head() and Reader::head(), but instead of being shared like CommitRef, it is fully owned.

let (reader, _) = someday::new::<String>("hello".into());

// This is a ref-counted String.
let reference: CommitRef<String> = reader.head();

// This is an owned String.
let owned: Commit<String> = reference.as_ref().clone();

// This may or may not actually deallocate the String.
drop(reference);

// The String's destructor will run here.
drop(owned);

Fields

timestamp: Timestamp

Timestamp of this Commit.

Starts at 0, and increments by 1 every time a commit-like operation is called by the Writer.

data: T

The generic data T.

Implementations

impl<T: Clone> Commit<T>

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

where T: PartialEq<T>,

If there is a difference in self and other’s timestamps or data.

// Timestamp is different.
let commit_1 = Commit { timestamp: 0, data: "a" };
let commit_2 = Commit { timestamp: 1, data: "a" };
assert!(commit_1.diff(&commit_2));

// Data is different.
let commit_3 = Commit { timestamp: 0, data: "a" };
let commit_4 = Commit { timestamp: 0, data: "b" };
assert!(commit_3.diff(&commit_4));

// Same.
let commit_5 = Commit { timestamp: 0, data: "a" };
let commit_6 = Commit { timestamp: 0, data: "a" };
assert!(!commit_5.diff(&commit_6));

pub const fn diff_timestamp(&self, other: &Self) -> bool

If there is a difference in self & other’s timestamps.

// Timestamp is different, data is same.
let commit_1 = Commit { timestamp: 0, data: "" };
let commit_2 = Commit { timestamp: 1, data: "" };
assert!(commit_1.diff_timestamp(&commit_2));

// Timestamp is same, data is different.
let commit_3 = Commit { timestamp: 0, data: "" };
let commit_4 = Commit { timestamp: 0, data: "a" };
assert!(!commit_3.diff_timestamp(&commit_4));

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

where T: PartialEq<T>,

If there is a difference in self & other’s timestamps.

// Timestamp is different, data is same.
let commit_1 = Commit { timestamp: 0, data: "a" };
let commit_2 = Commit { timestamp: 1, data: "a" };
assert!(!commit_1.diff_data(&commit_2));

// Timestamp is same, data is different.
let commit_3 = Commit { timestamp: 0, data: "a" };
let commit_4 = Commit { timestamp: 0, data: "b" };
assert!(commit_3.diff_data(&commit_4));

pub const fn ahead(&self, other: &Self) -> bool

If self’s timestamp is ahead of other’s timestamp.

let commit_1 = Commit { timestamp: 0, data: "" };
let commit_2 = Commit { timestamp: 1, data: "" };
assert!(!commit_1.ahead(&commit_2));

let commit_3 = Commit { timestamp: 2, data: "" };
let commit_4 = Commit { timestamp: 1, data: "" };
assert!(commit_3.ahead(&commit_4));

let commit_5 = Commit { timestamp: 2, data: "" };
let commit_6 = Commit { timestamp: 2, data: "" };
assert!(!commit_5.ahead(&commit_6));

pub const fn behind(&self, other: &Self) -> bool

If self’s timestamp is behind of other’s timestamp.

let commit_1 = Commit { timestamp: 0, data: "" };
let commit_2 = Commit { timestamp: 1, data: "" };
assert!(commit_1.behind(&commit_2));

let commit_3 = Commit { timestamp: 2, data: "" };
let commit_4 = Commit { timestamp: 1, data: "" };
assert!(!commit_3.behind(&commit_4));

let commit_5 = Commit { timestamp: 2, data: "" };
let commit_6 = Commit { timestamp: 2, data: "" };
assert!(!commit_5.behind(&commit_6));

Trait Implementations

impl<'__de, T> BorrowDecode<'__de> for Commit<T>

where T: BorrowDecode<'__de> + Clone,

fn borrow_decode<__D: BorrowDecoder<'__de>>( decoder: &mut __D ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<T> BorshDeserialize for Commit<T>

where T: BorshDeserialize + Clone,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<T> BorshSerialize for Commit<T>

where T: BorshSerialize + Clone,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

impl<T: Clone + Clone> Clone for Commit<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone> Debug for Commit<T>

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

Formats the value using the given formatter.

impl<T> Decode for Commit<T>

where T: Decode + Clone,

fn decode<__D: Decoder>(decoder: &mut __D) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

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

where T: Deserialize<'de> + Clone,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Commit<T>

where T: Clone + Display,

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

let (r, mut w) = someday::new(String::from("hello"));

let display: String = format!("{}", r.head());
assert_eq!(display, "hello");

impl<T> Encode for Commit<T>

where T: Encode + Clone,

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl<T: Clone> From<Commit<T>> for Writer<T>

fn from(commit: Commit<T>) -> Self

Same as crate::free::from_commit but without creating a Reader.

impl<T: Hash + Clone> Hash for Commit<T>

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<T: Ord + Clone> Ord for Commit<T>

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

fn eq(&self, other: &Commit<T>) -> 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<T: PartialOrd + Clone> PartialOrd for Commit<T>

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

where T: Serialize + Clone,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Clone> TryFrom<Arc<Commit<T>>> for Commit<T>

fn try_from(commit: CommitRef<T>) -> Result<Self, Self::Error>

This cheaply acquires ownership of a shared CommitRef if you are the only one holding onto it.

let (r, mut w) = someday::new(String::from("hello"));

let commit_ref = r.head();
// Force the `Writer` to advance onto the next commit.
w.add_commit_push(|_, _| {});

// Now there's only 1 strong count on `commit_ref`,
// this can be turned into an owned commit.
let commit_owned: Commit<String> = commit_ref.try_into().unwrap();

type Error = Arc<Commit<T>>

The type returned in the event of a conversion error.

impl<T: Copy + Clone> Copy for Commit<T>

impl<T: Eq + Clone> Eq for Commit<T>

impl<T: Clone> StructuralPartialEq for Commit<T>