Struct CatalogRecord 

#[non_exhaustive]
pub struct CatalogRecord {
    pub catalog_namespace_id: NamespaceId,
    pub folder_namespace_id: NamespaceId,
    pub key: Vec<u8>,
    pub hash: Hash,
    pub size: u64,
    pub folder_name: String,
    pub title: String,
    pub tags: Vec<String>,
    pub publisher: String,
}

A searchable metadata record published by a folder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

catalog_namespace_id: NamespaceId

The catalog containing this record. This is set by the catalog service when a record is written or imported.

folder_namespace_id: NamespaceId

key: Vec<u8>

hash: Hash

size: u64

folder_name: String

title: String

tags: Vec<String>

publisher: String

Implementations

impl CatalogRecord

pub fn new( folder_namespace_id: NamespaceId, key: impl AsRef<[u8]>, hash: Hash, size: u64, ) -> Self

Create a record using the key’s file name as its title.

pub const fn in_catalog(self, namespace_id: NamespaceId) -> Self

Set the namespace containing this record.

pub fn validate(&self) -> Result<()>

Errors

Returns an error if required searchable metadata is empty.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Errors

Returns an error if the record is invalid or cannot be encoded.

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self>

Errors

Returns an error if the record cannot be decoded or is invalid.

Trait Implementations

impl Clone for CatalogRecord

fn clone(&self) -> CatalogRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CatalogRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CatalogRecord

impl PartialEq for CatalogRecord

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CatalogRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CatalogRecord