Skip to main content

UserPrefixDictionary

Struct UserPrefixDictionary 

Source
pub struct UserPrefixDictionary {
    pub da: DoubleArrayAhoCorasick<u32>,
    pub vals_data: Data,
    pub words_idx_data: Data,
    pub words_data: Data,
    pub is_system: bool,
}
Expand description

The user prefix dictionary: a daachorse Aho-Corasick automaton.

The field sequence is byte-for-byte the sequence the pre-v6 PrefixDictionary archived (da, vals_data, words_idx_data, words_data, is_system). rkyv 0.8 archives structurally, without type names, so keeping the sequence is what lets every previously-built user dictionary .bin keep loading. Do not add, remove or reorder fields without bumping the dictionary format version and rebuilding the committed .bin fixtures.

Fields§

§da: DoubleArrayAhoCorasick<u32>

The Aho-Corasick automaton over surface forms.

§vals_data: Data

The values file: WordEntry records back to back.

§words_idx_data: Data

Byte offsets into words_data, one u32 per word id.

§words_data: Data

Word detail records.

§is_system: bool

Always false; retained because the archived field sequence must not change (see the type-level comment).

Implementations§

Source§

impl UserPrefixDictionary

Source

pub fn decode_val(&self, val: u32) -> (u32, u32)

Decode the (offset, count) pair stored in the double-array value.

The word-id offset lives in the high 24 bits and the per-surface variant count in the low 8 bits (up to 255 variants). The legacy 5-bit encoding was retired in v4.0.0; user .bin files built with v3 must be rebuilt from CSV.

§Arguments
  • val - The packed automaton value.
§Returns

The (offset, count) pair.

Source

pub fn load( da_data: impl Into<Data>, vals_data: impl Into<Data>, words_idx_data: impl Into<Data>, words_data: impl Into<Data>, ) -> LinderaResult<UserPrefixDictionary>

Load a UserPrefixDictionary from raw binary data.

The automaton bytes are always run through daachorse’s validating deserializer: user dictionaries come from the filesystem or from callers, never from this crate’s own build pipeline, so there is no trusted path.

§Arguments
  • da_data - Serialized automaton bytes.
  • vals_data - Values data bytes.
  • words_idx_data - Word index data bytes.
  • words_data - Words data bytes.
§Returns

A UserPrefixDictionary, or an error if deserialization fails.

Trait Implementations§

Source§

impl Archive for UserPrefixDictionary

Source§

type Archived = ArchivedUserPrefixDictionary

The archived representation of this type. Read more
Source§

type Resolver = UserPrefixDictionaryResolver

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

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. Read more
Source§

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. Read more
Source§

impl Clone for UserPrefixDictionary

Source§

fn clone(&self) -> UserPrefixDictionary

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'de> Deserialize<'de> for UserPrefixDictionary

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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

Deserializes using the given deserializer
Source§

impl Serialize for UserPrefixDictionary

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> ArchiveUnsized for T
where T: Archive,

Source§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
Source§

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

Source§

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.