Skip to main content

Store

Struct Store 

Source
pub struct Store { /* private fields */ }

Implementations§

Source§

impl Store

Source

pub fn from_project_root(project_root: impl AsRef<Path>) -> Self

Source

pub fn from_storage_root(storage_root: impl AsRef<Path>) -> Self

Source

pub async fn resolve_from_context(ctx: &RepositoryContext) -> StoreResult<Self>

§Errors

Returns an error when global storage cannot be resolved or an existing local .parley marker is not a directory.

Source

pub async fn resolve(project_root: impl AsRef<Path>) -> StoreResult<Self>

§Errors

Returns an error when global storage cannot be resolved or an existing local .parley marker is not a directory.

Source

pub async fn resolve_with_global_root( project_root: impl AsRef<Path>, global_root: impl AsRef<Path>, ) -> StoreResult<Self>

§Errors

Returns an error when an existing local .parley marker is not a directory.

Source

pub async fn resolve_with_local_and_global_root( local_root: impl AsRef<Path>, storage_root: impl AsRef<Path>, global_root: impl AsRef<Path>, project_root: &Path, ) -> StoreResult<Self>

§Errors

Returns an error when an existing local .parley marker is not a directory. Prefers local_root if it exists, falls back to storage_root, then to global storage.

Source

pub fn root_path(&self) -> &Path

Source

pub async fn ensure_dirs(&self) -> StoreResult<()>

§Errors

Returns an error when the .parley review directories cannot be created.

Source

pub async fn create_review(&self, session: &ReviewSession) -> StoreResult<()>

§Errors

Returns an error when the review name is invalid or the review cannot be written.

Source

pub async fn save_review(&self, session: &ReviewSession) -> StoreResult<()>

§Errors

Returns an error when the review name is invalid, directories cannot be created, the session cannot be serialized, or the review file cannot be written.

Source

pub async fn load_review(&self, name: &str) -> StoreResult<ReviewSession>

§Errors

Returns an error when the review name is invalid, the review is missing, or review data cannot be read or deserialized.

Source

pub async fn list_reviews(&self) -> StoreResult<Vec<String>>

§Errors

Returns an error when review directories cannot be read or persisted review files cannot be deserialized.

Source

pub fn review_log_path(&self, review_name: &str) -> StoreResult<PathBuf>

§Errors

Returns an error when review_name is invalid.

Source

pub async fn load_config(&self) -> StoreResult<AppConfig>

§Errors

Returns an error when config directories cannot be created or config data cannot be read or deserialized.

Source

pub async fn save_config(&self, config: &AppConfig) -> StoreResult<()>

§Errors

Returns an error when config directories cannot be created, config data cannot be serialized, or the config file cannot be written.

Trait Implementations§

Source§

impl Clone for Store

Source§

fn clone(&self) -> Store

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 Store

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Store

§

impl RefUnwindSafe for Store

§

impl Send for Store

§

impl Sync for Store

§

impl Unpin for Store

§

impl UnsafeUnpin for Store

§

impl UnwindSafe for Store

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