Struct Metadata 

pub struct Metadata {

    pub format_version: u32,
    pub name: String,
    pub encoding: String,
    pub default_word_cost: i16,
    pub default_left_context_id: u16,
    pub default_right_context_id: u16,
    pub default_field_value: String,
    pub flexible_csv: bool,
    pub skip_invalid_cost_or_id: bool,
    pub normalize_details: bool,
    pub connection_id_mapping: bool,
    pub context_id_map: Option<ContextIdMap>,
    pub dictionary_schema: Schema,
    pub user_dictionary_schema: Schema,
    pub model_info: Option<ModelInfo>,
}

Fields

format_version: u32

On-disk layout version of the dictionary directory this metadata was written into. See DICTIONARY_FORMAT_VERSION.

Absent from source metadata.json files, which describe build inputs rather than a built dictionary, and absent from dictionaries built before the field existed; both read back as [LEGACY_FORMAT_VERSION].

name: String

encoding: String

default_word_cost: i16

default_left_context_id: u16

default_right_context_id: u16

default_field_value: String

flexible_csv: bool

skip_invalid_cost_or_id: bool

normalize_details: bool

connection_id_mapping: bool

Reorder connection-cost context IDs by frequency at build time so that frequently-used connection-matrix cells cluster in cache. Optional and defaults to false; when false the field is omitted from metadata.json so existing files stay byte-identical, and the build output is unchanged.

context_id_map: Option<ContextIdMap>

The context-ID permutation that was applied when this dictionary was built.

Written into the built metadata.json when connection_id_mapping is on, so that anything compiled later against this dictionary — most importantly a detailed user dictionary — can be relabeled into the same ID space. Absent (and omitted from the file) for an un-remapped dictionary, which keeps those builds byte-identical. Source metadata.json files carry only the boolean flag.

dictionary_schema: Schema

user_dictionary_schema: Schema

model_info: Option<ModelInfo>

Implementations

impl Metadata

pub fn new( name: String, encoding: String, simple_word_cost: i16, default_left_context_id: u16, default_right_context_id: u16, default_field_value: String, flexible_csv: bool, skip_invalid_cost_or_id: bool, normalize_details: bool, schema: Schema, userdic_schema: Schema, ) -> Self

pub fn load(data: &[u8]) -> LinderaResult<Self>

Load metadata from binary data (JSON format). This provides a consistent interface with other dictionary components.

pub fn validate_format_version(&self) -> LinderaResult<()>

Rejects a built dictionary whose on-disk layout this build cannot read.

Call this after loading the metadata.json of a built dictionary directory. Do not call it on a source metadata.json: those describe build inputs (schema, encoding, flexible_csv and friends), carry no format_version, and stay valid across format changes.

Without this check a stale dictionary is not merely unreadable but silently wrong: matrix.mtx, dict.vals and dict.words are headerless raw arrays, so an old file of a plausible length decodes into garbage costs rather than failing.

Returns

Ok(()) when the dictionary was built with this crate’s format version, otherwise an error naming both versions and how to recover.

pub fn load_or_default(data: &[u8], default_fn: fn() -> Self) -> Self

Load metadata with fallback to default values. This is used when feature flags are disabled and data might be empty.

Trait Implementations

impl Archive for Metadata

where u32: Archive, String: Archive, i16: Archive, u16: Archive, bool: Archive, Option<ContextIdMap>: Archive, Schema: Archive, Option<ModelInfo>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedMetadata

The archived representation of this type.

type Resolver = MetadataResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Metadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<Metadata, __D> for Archived<Metadata>

where u32: Archive, <u32 as Archive>::Archived: Deserialize<u32, __D>, String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, i16: Archive, <i16 as Archive>::Archived: Deserialize<i16, __D>, u16: Archive, <u16 as Archive>::Archived: Deserialize<u16, __D>, bool: Archive, <bool as Archive>::Archived: Deserialize<bool, __D>, Option<ContextIdMap>: Archive, <Option<ContextIdMap> as Archive>::Archived: Deserialize<Option<ContextIdMap>, __D>, Schema: Archive, <Schema as Archive>::Archived: Deserialize<Schema, __D>, Option<ModelInfo>: Archive, <Option<ModelInfo> as Archive>::Archived: Deserialize<Option<ModelInfo>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Metadata, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Serialize for Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for Metadata

where u32: Serialize<__S>, String: Serialize<__S>, i16: Serialize<__S>, u16: Serialize<__S>, bool: Serialize<__S>, Option<ContextIdMap>: Serialize<__S>, Schema: Serialize<__S>, Option<ModelInfo>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.