Struct tantivy::SegmentId

pub struct SegmentId(_);

Uuid identifying a segment.

Tantivy's segment are identified by a UUID which is used to prefix the filenames of all of the file associated with the segment.

In unit test, for reproducability, the SegmentId are simply generated in an autoincrement fashion.

Methods

impl SegmentId

pub fn short_uuid_string(&self) -> String

Returns a shorter identifier of the segment.

We are using UUID4, so only 6 bits are fixed, and the rest is random.

Picking the first 8 chars is ok to identify segments in a display message (e.g. a5c4dfcb).

pub fn uuid_string(&self) -> String

Returns a segment uuid string.

It consists in 32 lowercase hexadecimal chars (e.g. a5c4dfcbdfe645089129e308e26d5523)

pub fn from_uuid_string(
    uuid_string: &str
) -> Result<SegmentId, SegmentIdParseError>

Build a SegmentId string from the full uuid string.

E.g. "a5c4dfcbdfe645089129e308e26d5523"

Trait Implementations

impl Clone for SegmentId

fn clone(&self) -> SegmentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SegmentId

impl Debug for SegmentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SegmentId

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

Deserialize this value from the given Serde deserializer.

impl Eq for SegmentId

impl FromStr for SegmentId

type Err = SegmentIdParseError

The associated error which can be returned from parsing.

fn from_str(uuid_string: &str) -> Result<Self, SegmentIdParseError>

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

impl Hash for SegmentId

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for SegmentId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<SegmentId> for SegmentId

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

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

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

This method tests for !=.

impl PartialOrd<SegmentId> for SegmentId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Serialize for SegmentId

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

Serialize this value into the given Serde serializer.

impl StructuralEq for SegmentId

impl StructuralPartialEq for SegmentId