Struct IndexMetadata

pub struct IndexMetadata {
    pub uuid: Option<Uuid>,
    pub fields: Vec<i32>,
    pub name: String,
    pub dataset_version: u64,
    pub fragment_bitmap: Vec<u8>,
}

Metadata describing the index.

Fields

uuid: Option<Uuid>

Unique ID of an index. It is unique across all the dataset versions.

fields: Vec<i32>

The columns to build the index.

name: String

Index name. Must be unique within one dataset version.

dataset_version: u64

The version of the dataset this index was built from.

fragment_bitmap: Vec<u8>

/ A bitmap of the included fragment ids. / / This may by used to determine how much of the dataset is covered by the / index. This information can be retrieved from the dataset by looking at / the dataset at dataset_version. However, since the old version may be / deleted while the index is still in use, this information is also stored / in the index. / / The bitmap is stored as a 32-bit Roaring bitmap.

Trait Implementations

impl Clone for IndexMetadata

fn clone(&self) -> IndexMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexMetadata

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

Formats the value using the given formatter.

impl Default for IndexMetadata

fn default() -> Self

Returns the “default value” for a type.

impl From<&Index> for IndexMetadata

fn from(idx: &Index) -> Self

Converts to this type from the input type.

impl Message for IndexMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for IndexMetadata

fn eq(&self, other: &IndexMetadata) -> 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 TryFrom<IndexMetadata> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(proto: IndexMetadata) -> Result<Self>

Performs the conversion.

impl StructuralPartialEq for IndexMetadata