Skip to main content

SessionNavigator

oxi::session_navigation

Struct SessionNavigator 

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

Session navigator for tree-based session management

Implementations§

Source§

impl SessionNavigator

Source

pub fn new() -> SessionNavigator

Create a new session navigator

Source

pub fn from_entries( entries: Vec<SessionEntryType>, leaf_id: Option<Uuid>, ) -> SessionNavigator

Create from existing entries

Source

pub fn get_leaf_id(&self) -> Option<Uuid>

Get the current leaf ID

Source

pub fn get_entry(&self, id: Uuid) -> Option<&SessionEntryType>

Get an entry by ID

Source

pub fn get_label(&self, id: Uuid) -> Option<&str>

Get the label for an entry, if any

Source

pub fn get_entries(&self) -> Vec<&SessionEntryType>

Get all entries

Source

pub fn get_branch(&self, from_id: Option<Uuid>) -> Vec<&SessionEntryType>

Get the branch path from root to a given entry

Source

pub fn get_children(&self, parent_id: Uuid) -> Vec<&SessionEntryType>

Get all direct children of an entry

Source

pub fn collect_entries_for_branch_summary( &self, old_leaf_id: Option<Uuid>, target_id: Uuid, ) -> CollectEntriesResult

Collect entries that should be summarized when navigating from one position to another.

Source

pub fn navigate_tree<N>( &mut self, target_id: Uuid, options: NavigationOptions, summarizer: Option<&N>, extension_hook: Option<&dyn Fn(TreePreparation) -> BeforeTreeHookResult>, ) -> NavigationResult
where N: Summarizer + ?Sized,

Navigate to a target entry in the session tree.

Source

pub fn branch(&mut self, branch_from_id: Uuid)

Switch to a different entry (start a new branch).

Source

pub fn reset_leaf(&mut self)

Reset the leaf pointer to null (before any entries).

Source

pub fn branch_with_summary( &mut self, branch_from_id: Option<Uuid>, summary: String, details: Option<BranchSummaryDetails>, from_hook: bool, ) -> Uuid

Start a new branch with a summary of the abandoned path.

Source

pub fn append_label_change( &mut self, target_id: Uuid, label: Option<String>, ) -> Uuid

Set or clear a label on an entry.

Source

pub fn add_entry(&mut self, entry: SessionEntryType)

Add an entry to the session

Source

pub fn get_label_timestamp(&self, id: Uuid) -> Option<i64>

Get the label timestamp for an entry, if any

Trait Implementations§

Source§

impl Default for SessionNavigator

Source§

fn default() -> SessionNavigator

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

Source§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
Source§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
Source§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more
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> 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> 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 Pointer = u32

Source§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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