Struct Uid 

pub struct Uid { /* private fields */ }

Each chunk, image and file has uid.

Uid is a 256 bit hash value, generated by sha3-256 hash function and some postprocessing. The most convenient way for users to deal with uid is using uid_query function. The user inputs a hex representation of a uid, or a prefix of it, and the function returns matched uids.

The first 192 bits (128 of high + 64 of low) are from the hash function, and the remaining bits are for metadata.

Implementations

impl Uid

pub fn decode(bytes: &[u8]) -> Result<Self, Error>

pub fn encode(&self, buffer: &mut Vec<u8>)

pub fn new_chunk(chunk: &Chunk) -> Self

pub fn new_image(bytes: &[u8]) -> Self

pub fn new_file(root_dir: &str, path: &str) -> Result<Self, Error>

pub fn new_group(uids: &[Uid]) -> Self

pub fn new_knowledge_base(uids: &[Uid]) -> Self

pub fn new_summary(summary: &str) -> Self

pub fn new_query_turn(turn: &QueryTurn) -> Self

pub fn update_file_uid(old: Uid, old_path: &str, new_path: &str) -> Self

pub fn get_prefix(&self) -> String

pub fn get_suffix(&self) -> String

pub fn abbrev(&self, n: usize) -> String

It returns the first n characters of the uid. It returns the full uid if n is greater than or equal to 64.

pub fn is_valid_prefix(s: &str) -> bool

Trait Implementations

impl Add for Uid

fn add(self, rhs: Self) -> Self

It wraps result when there’s an overflow.

type Output = Uid

The resulting type after applying the + operator.

impl AddAssign for Uid

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitXor for Uid

type Output = Uid

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl BitXorAssign for Uid

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Uid

fn clone(&self) -> Uid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Uid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Uid

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Uid

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

Formats the value using the given formatter.

impl FromStr for Uid

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl Hash for Uid

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 Ord for Uid

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

fn eq(&self, other: &Uid) -> 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 PartialOrd for Uid

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Uid

impl Eq for Uid

impl StructuralPartialEq for Uid