Skip to main content

Env

Struct Env 

Source
pub struct Env<'a> {
    pub config: &'a Config,
    pub paths: &'a StorePaths,
    pub window: TimeWindow,
    pub project: Option<&'a str>,
    pub json: bool,
    pub no_ingest: bool,
    pub include_sidechain: bool,
}
Expand description

The resolved global flags a reporting command needs.

Borrowed rather than owned so main can resolve config and paths once and hand the same view to every command.

Fields§

§config: &'a Config§paths: &'a StorePaths§window: TimeWindow§project: Option<&'a str>§json: bool§no_ingest: bool§include_sidechain: bool

Sidechain (subagent) events are real spend, so they are in by default.

Implementations§

Source§

impl Env<'_>

Source

pub fn ctx(&self) -> ReportCtx

The reporting context, priced from the current config: cost is derived at read time, so an edit to [pricing.*] re-prices the store on the next report rather than only on newly ingested events.

Source

pub fn pre_ingest(&self) -> Result<()>

The implicit ingest before a report, unless --no-ingest.

Its progress goes to stderr: stdout belongs to the report, and in --json mode it must stay a single parseable document.

Trait Implementations§

Source§

impl<'a> Clone for Env<'a>

Source§

fn clone(&self) -> Env<'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
Source§

impl<'a> Copy for Env<'a>

Source§

impl<'a> Debug for Env<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Env<'a>

§

impl<'a> RefUnwindSafe for Env<'a>

§

impl<'a> Send for Env<'a>

§

impl<'a> Sync for Env<'a>

§

impl<'a> Unpin for Env<'a>

§

impl<'a> UnsafeUnpin for Env<'a>

§

impl<'a> UnwindSafe for Env<'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
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 = 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.