Skip to main content

Agent

Struct Agent 

Source
pub struct Agent { /* private fields */ }
Expand description

Agent encapsulates query, key, and state for trie operations.

An agent is used for:

  • Lookup operations (query → key with ID)
  • Reverse lookup (query with ID → key with string)
  • Common prefix search
  • Predictive search

Implementations§

Source§

impl Agent

Source

pub fn new() -> Self

Creates a new empty agent.

Source

pub fn query(&self) -> &Query

Returns a reference to the query.

Source

pub fn query_mut(&mut self) -> &mut Query

Returns a mutable reference to the query.

Source

pub fn key(&self) -> &Key

Returns a reference to the key.

Source

pub fn key_mut(&mut self) -> &mut Key

Returns a mutable reference to the key.

Source

pub fn set_query_str(&mut self, s: &str)

Sets the query from a string slice.

Source

pub fn set_query_bytes(&mut self, bytes: &[u8])

Sets the query from a byte slice.

Source

pub fn set_query_id(&mut self, key_id: usize)

Sets the query from a key ID for reverse lookup.

Source

pub fn state(&self) -> Option<&State>

Returns a reference to the state if it exists.

Source

pub fn state_mut(&mut self) -> Option<&mut State>

Returns a mutable reference to the state if it exists.

Source

pub fn set_key_str(&mut self, s: &str)

Sets the key from a string slice.

Source

pub fn set_key_bytes(&mut self, bytes: &[u8])

Sets the key from a byte slice.

Source

pub fn set_key_id(&mut self, id: usize)

Sets the key ID.

Source

pub fn set_key_from_state_buf(&mut self)

Sets the key to point to the state’s key buffer.

This is used after operations like reverse_lookup that build the key in the state’s buffer.

Source

pub fn set_key_from_query(&mut self)

Sets the key to point to the query buffer.

This is used after a successful lookup to set the result key to the query string that was searched for.

Source

pub fn set_key_from_query_prefix(&mut self, length: usize)

Sets the key to point to a prefix of the query buffer.

This is used during prefix searches to set the result key to a prefix of the query string.

§Arguments
  • length - Length of the prefix
Source

pub fn has_state(&self) -> bool

Returns true if the agent has state.

Source

pub fn init_state(&mut self) -> Result<()>

Initializes state for complex searches.

§Errors

Returns an error if state is already initialized.

Source

pub fn clear(&mut self)

Clears the agent to empty state.

Source

pub fn swap(&mut self, other: &mut Agent)

Swaps with another agent.

Trait Implementations§

Source§

impl Clone for Agent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Agent

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Agent

§

impl RefUnwindSafe for Agent

§

impl Send for Agent

§

impl Sync for Agent

§

impl Unpin for Agent

§

impl UnwindSafe for Agent

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> 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> 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> 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.