Skip to main content

Context

Struct Context 

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

Implementations§

Source§

impl Context

Source

pub fn new(home: PathBuf) -> Context

Claude Code’s defaults for a person whose home is home: ~/.pitboard, ~/.claude, the default credential slot, claude looked up on PATH, and no proxy. An app starts here and sets only what differs. Pitboard’s own directory is the system’s default for home, the home handed in and never this account’s own.

Source

pub fn with_codex_home(self, dir: String) -> Context

Where Codex keeps its login. Empty means unset, as Codex reads it.

Source

pub fn with_pitboard_home(self, dir: PathBuf) -> Context

Source

pub fn with_claude_config_dir(self, dir: String) -> Context

Claude Code’s config directory, as CLAUDE_CONFIG_DIR names it. Empty is kept, as Claude Code keeps it: unset for its config file and its credential slot’s name, but the empty path for its config dir, as the register’s config_file_location says, which is refused as a home that is not a full path.

Source

pub fn with_secure_storage_dir(self, dir: String) -> Context

Empty is set, and pins the default slot, as Claude Code reads CLAUDE_SECURESTORAGE_CONFIG_DIR.

Source

pub fn with_argv_fallback(self, allowed: bool) -> Context

The login name whose keychain account Claude Code stores under. Allows the argument-line write for a login too large for the stdin one.

Source

pub fn custom_oauth(&self) -> bool

Whether a custom OAuth endpoint is configured, which moves Claude Code’s login.

Source

pub fn claude_program(&self) -> &Path

The claude Pitboard would run to sign someone in.

Source

pub fn argv_fallback(&self) -> bool

Whether the argument-line write is allowed for an oversized login.

Source

pub fn overriding_auth(&self) -> &[String]

Environment variables that authenticate Claude Code some other way, if any.

Source

pub fn with_caller(self, caller: String) -> Context

Names the front end in the audit log.

Source

pub fn with_user(self, user: String) -> Context

Source

pub fn with_claude_program(self, program: PathBuf) -> Context

An app started from Finder does not see the shell’s PATH, so it names claude itself.

Source

pub fn with_codex_program(self, program: PathBuf) -> Context

The same for codex.

Source

pub fn codex_program(&self) -> &Path

The codex Pitboard would run to sign someone in.

Source

pub fn with_schedule_program(self, program: PathBuf) -> Context

An app is not a command line, so it names the one it comes with for the schedule to run.

Source

pub fn schedule_program(&self) -> Option<&Path>

The Pitboard the daily renewal schedule is written to run, where one was named.

Source

pub fn with_search_path(self, path: String) -> Context

Look for a tool’s program on path, in PATH’s form, rather than on this process’s own PATH. An app opened from Finder has only the system’s directories there, so a tool installed through a version manager or an npm prefix is found only on the PATH the person’s shell has, and a script it runs finds its interpreter only there.

Source

pub fn started_by_the_schedule(self) -> Context

Say this process is a run of the daily renewal schedule, as the marker its job is started with says where what the system says of the job it started is not to be relied on: the command line does this for pitboard renew --scheduled. Such a run renews the default home whatever PITBOARD_HOME says (crate::schedule::SCHEDULED_RUN).

Source

pub fn program_for(&self, tool: ProviderId) -> &Path

The program named for this tool, found or not.

Source

pub fn from_env() -> Context

The command line’s context, from this process’s own environment.

Source

pub fn for_command_line(env: &Environment) -> Context

The command line’s context, from the environment it was started with: a shell’s, so each tool’s program is looked for on its PATH when it runs.

Trait Implementations§

Source§

impl Clone for Context

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 Context

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