Skip to main content

ConfigPaths

Struct ConfigPaths 

Source
pub struct ConfigPaths {
    pub global: PathBuf,
    pub project: Option<PathBuf>,
    pub custom: Option<PathBuf>,
    pub auth: PathBuf,
    pub cache_dir: PathBuf,
}
Expand description

Resolved paths for all config layers.

Fields§

§global: PathBuf

Global config file path.

§project: Option<PathBuf>

Project config file path (nearest opencode.json up to git root).

§custom: Option<PathBuf>

Custom config path from OPENCODE_CONFIG env var.

§auth: PathBuf

Auth file path.

§cache_dir: PathBuf

Cache directory for this tool.

Implementations§

Source§

impl ConfigPaths

Source

pub fn discover() -> Result<Self>

Discover all config paths following OpenCode conventions.

This respects environment variables:

  • OPENCODE_CONFIG: custom config file path
  • OPENCODE_CONFIG_DIR: custom config directory
  • OPENCODE_CONFIG_CONTENT: inline config (not file-based, skipped)
  • XDG_CONFIG_HOME: XDG config directory override
Source

pub fn global_config_path() -> Result<PathBuf>

Get the global config path.

Checks in order:

  1. OPENCODE_CONFIG_DIR env var
  2. ~/.config/opencode/opencode.json
  3. $XDG_CONFIG_HOME/opencode/opencode.json
  4. $HOME/.opencode.json (fallback)
Source

pub fn project_config_path() -> Result<Option<PathBuf>>

Find the project-level config by traversing up to the git root.

Starts from the current directory and walks up the tree until finding opencode.json or hitting the git root.

Source

pub fn auth_path() -> Result<PathBuf>

Get the auth.json file path.

Source

pub fn cache_dir() -> Result<PathBuf>

Get the cache directory for this tool.

Source

pub fn managed_config_path() -> Option<PathBuf>

Get the managed config path for the current platform (read-only awareness).

Source

pub fn path_for_layer(&self, layer: ConfigLayer) -> Option<&PathBuf>

Get the path for a specific config layer.

Trait Implementations§

Source§

impl Clone for ConfigPaths

Source§

fn clone(&self) -> ConfigPaths

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 ConfigPaths

Source§

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

Formats the value using the given formatter. 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> 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> 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> 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