Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub projects: BTreeMap<String, Project>,
}

Fields§

§projects: BTreeMap<String, Project>

Implementations§

Source§

impl Config

Source

pub fn load() -> Result<Self, Error>

Source

pub fn save(&self) -> Result<(), Error>

Write the registry to disk atomically.

Callers that read-modify-write the registry should go through Config::update instead, so the whole cycle is serialized against other grove processes.

Source

pub fn update<T, F>(f: F) -> Result<T, Error>
where F: FnOnce(&mut Self) -> Result<T, Error>,

Read-modify-write the registry while holding the exclusive config lock.

f receives the config as it exists on disk right now — not a copy loaded earlier — so concurrent grove processes queue up instead of dropping each other’s projects.

Source

pub fn add_project(&mut self, name: String, path: PathBuf) -> Result<(), Error>

Source

pub fn register_discovered(&mut self, name: &str, project: Project) -> bool

Register a discovered project to the registry, printing a message to stderr. Returns true if the project was newly registered, false if it was already present or could not be saved.

Only ever called for write-intent commands (see AutoRegister) — read-only commands must not mutate the registry, because grove env export runs on every directory change under the mise integration.

The registry is re-read under the config lock before the insert, so a project registered concurrently by another grove process is never dropped. On failure this prints a warning and leaves both disk and memory untouched; registration is a convenience and must never block the command that triggered it.

Unlike [add_project], this skips VCS validation and path canonicalization because discover() has already verified and canonicalized the path.

Source

fn insert_discovered( name: &str, project: Project, ) -> Result<(Self, bool), Error>

Insert project into the on-disk registry under the config lock. Returns the resulting config and whether this call added the entry.

Source

pub fn remove_project(&mut self, name: &str) -> Result<(), Error>

Source

pub fn find_project_for_path( &self, path: &Path, ) -> Result<Option<ProjectRef>, Error>

Find which project a path belongs to.

Checks in order:

  1. Path is a subdirectory of a project’s worktree base (more specific match)
  2. Path is a subdirectory of a project’s main repo

Trait Implementations§

Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Config

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

impl<'de> Deserialize<'de> for Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.

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
§

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

§

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
§

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