Skip to main content

SessionDirSpec

Struct SessionDirSpec 

Source
pub struct SessionDirSpec {
    pub session_name: Option<String>,
    pub session_path: Option<String>,
    pub reuse: SessionReuse,
    pub session_keep: usize,
    pub session_shelflife: Duration,
    pub force_new: bool,
}
Expand description

Resolved session inputs from CLI / env. Built by resolve_session_dir from one of:

  • The umbrella --session <kv-list> flag (a comma-separated list of key:value pairs and bare shortcuts).
  • Per-key long-form flags (--session-name, --session-path, --session-reuse, --session-keep, --session-shelflife).
  • SESSION_DIRECTORY env var (equivalent to --session-path).

When both forms are present the long-form flag wins; the umbrella flag is shorthand. Within the umbrella value the last-wins rule applies if a key is repeated.

Fields§

§session_name: Option<String>

name — session id (basename of the session directory). Used in metric labels and as the resolved value of the SESSION token in path. When unset, defaults to the auto-generated <scenario>_<timestamp> form.

§session_path: Option<String>

path — full directory path. Optional SESSION token inside the path is replaced with session_name at write time. When unset, the path is logs/<session_name>/.

§reuse: SessionReuse

reuse — policy when the resolved directory already contains prior session artifacts. Default Error.

§session_keep: usize

keep — number of session directories retained under the parent at startup. Default 10. 0 disables.

§session_shelflife: Duration

shelflife — max age of a session directory before purge at startup. Default 4 weeks. 0 disables.

§force_new: bool

SRD-106 — the umbrella bare token new (--session new): force a fresh auto-named session. Its only consumer is the stick_session resolution rung, which it defeats; with no stick in play a fresh session is already the default, so the token is a harmless no-op there.

Implementations§

Source§

impl SessionDirSpec

Source

pub fn is_empty(&self) -> bool

true when no path/name flag is set — caller falls back to the default logs/<auto_id>/ behavior. (reuse, keep, shelflife are always present at their defaults and don’t count toward “is this empty?”.)

Source

pub fn resolve(&self, auto_id: &str) -> Option<(PathBuf, String)>

Resolve to a concrete (output_dir, session_id).

  • auto_id is the fallback session name when session_name is unset.
  • The resolved id = session_name.unwrap_or(auto_id).
  • The resolved path = session_path (with SESSION token replaced by the resolved id) if set, else logs/<id>/.

Returns None only when the spec is empty and the caller should use defaults; otherwise Some with the resolved values.

Source

pub fn needs_auto_id(&self) -> bool

true if the resolved path needs the auto-id (i.e. neither session_name nor a fully-concrete session_path is set). Used at startup to decide whether logs/latest can be wired immediately or must wait for session creation.

Trait Implementations§

Source§

impl Clone for SessionDirSpec

Source§

fn clone(&self) -> Self

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 Debug for SessionDirSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SessionDirSpec

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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