Skip to main content

StudyLocator

Struct StudyLocator 

pub struct StudyLocator<'a> { /* private fields */ }
Expand description

Resolves study identity through a storage backend’s optional catalog.

Construct one locator at an adapter boundary and use it for create, list and name lookup decisions. A backend that does not opt into StudyCatalog produces Error::Unsupported from every operation; callers must not fall back to probing conventional crate::id::StudyId values.

Implementations§

§

impl<'a> StudyLocator<'a>

pub const fn new(storage: &'a dyn Storage) -> Self

Binds a locator to one storage backend.

pub fn catalog(&self) -> Result<&dyn StudyCatalog>

Returns the optional catalog capability, or a typed unsupported error.

This is the single capability check shared by the operation methods.

§Errors

Returns Error::Unsupported when the bound storage does not provide a study catalog.

pub fn create_if_empty(&self, cfg: StudyConfig) -> Result<StudyCreateOutcome>

Atomically creates a study when the bound catalog is empty.

§Errors

Returns Error::Unsupported when the catalog is unavailable, or the catalog’s backend error when creation fails.

pub fn list_studies(&self) -> Result<Vec<StudySummary>>

Lists all study summaries in the catalog’s deterministic order.

§Errors

Returns Error::Unsupported when the catalog is unavailable, or the catalog’s backend error when listing fails.

pub fn list(&self) -> Result<Vec<StudySummary>>

Short alias for list_studies.

§Errors

Returns the error from list_studies.

pub fn find_only(&self) -> Result<StudyLoadOutcome>

Applies the shared one-study policy to the catalog list.

An empty catalog is StudyLoadOutcome::NotFound, exactly one summary is StudyLoadOutcome::Loaded, and any multi-study catalog is StudyLoadOutcome::Conflict. The policy is intentionally implemented here so CLI, Python and GUI adapters do not each count summaries (or invent a numeric-id fallback).

§Errors

Returns Error::Unsupported when the catalog is unavailable, or the catalog’s backend error when listing fails. An empty or ambiguous catalog is returned as a typed StudyLoadOutcome.

pub fn load_only(&self) -> Result<StudyLoadOutcome>

Alias for find_only used by load-oriented adapters.

§Errors

Returns the error from find_only.

pub fn find_by_name(&self, name: &str) -> Result<StudyLoadOutcome>

Resolves an exact study name without selecting an ambiguous match.

§Errors

Returns Error::Unsupported when the catalog is unavailable, or the catalog’s backend error when lookup fails.

pub fn load_by_name(&self, name: &str) -> Result<StudyLoadOutcome>

Alias emphasizing that a successful lookup loads an identity.

§Errors

Returns the error from find_by_name.

Trait Implementations§

§

impl<'a> Clone for StudyLocator<'a>

§

fn clone(&self) -> StudyLocator<'a>

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
§

impl<'a> Copy for StudyLocator<'a>

§

impl Debug for StudyLocator<'_>

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for StudyLocator<'a>

§

impl<'a> !UnwindSafe for StudyLocator<'a>

§

impl<'a> Freeze for StudyLocator<'a>

§

impl<'a> Send for StudyLocator<'a>

§

impl<'a> Sync for StudyLocator<'a>

§

impl<'a> Unpin for StudyLocator<'a>

§

impl<'a> UnsafeUnpin for StudyLocator<'a>

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
§

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

§

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.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

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

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