Skip to main content

RecordIndex

Struct RecordIndex 

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

The typed records of every session on the machine: {"version": 1, "records": [...]} in one document. Writes read, change and replace the document while holding an exclusive lock on <path>.lock (file-backed), so two sessions never lose each other’s records.

Implementations§

Source§

impl RecordIndex

Source

pub fn in_memory() -> RecordIndex

Source

pub fn file(path: impl Into<PathBuf>) -> RecordIndex

The index file every session of an agent directory shares.

Source

pub fn for_agent_dir(agent_dir: &Path) -> RecordIndex

<agent dir>/memory/records.json.

Source

pub fn entries(&self) -> Result<Vec<IndexEntry>, String>

Every indexed record, in the order they were first indexed.

Source

pub fn entry(&self, id: &str) -> Result<Option<IndexEntry>, String>

The record with document id id.

Source

pub fn by_key( &self, key: &str, scope: &str, filters: &Map<String, Value>, ) -> Result<Option<IndexEntry>, String>

The visible record holding key in scope.

Source

pub fn upsert(&self, entry: IndexEntry) -> Result<(), String>

Add entry, replacing the record with its id (it keeps its place).

Source

pub fn remove(&self, id: &str) -> Result<(), String>

Trait Implementations§

Source§

impl Default for RecordIndex

Source§

fn default() -> Self

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

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more