Struct bonsaidb_core::document::Revision

pub struct Revision {
    pub id: u32,
    pub sha256: [u8; 32],
}

Information about a Document’s revision history.

Fields

id: u32

The current revision id of the document. This value is sequentially incremented on each document update.

sha256: [u8; 32]

The SHA256 digest of the bytes contained within the Document.

Implementations

impl Revision

pub fn new(contents: &[u8]) -> Self

Creates the first revision for a document with the SHA256 digest of the passed bytes.

pub fn with_id(id: u32, contents: &[u8]) -> Self

Creates a revision with id for a document with the SHA256 digest of the passed bytes.

pub fn next_revision(&self, new_contents: &[u8]) -> Option<Self>

Creates the next revision in sequence with an updated digest. If the digest doesn’t change, None is returned.

Panics

Panics if id overflows.

Trait Implementations

impl Clone for Revision

fn clone(&self) -> Revision

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Revision

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Revision

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Revision

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

Formats the value using the given formatter.

impl PartialEq<Revision> for Revision

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

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

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

This method tests for !=.

impl Serialize for Revision

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

Serialize this value into the given Serde serializer.

impl Eq for Revision

impl StructuralEq for Revision

impl StructuralPartialEq for Revision