Skip to main content

EventLog

Struct EventLog 

Source
pub struct EventLog { /* private fields */ }
Expand description

Local JSONL event log. Disabled (no-op) unless explicitly enabled.

Construct with EventLog::from_env for the documented opt-in behavior, or with EventLog::new / EventLog::disabled to pin a specific state (tests, adapters).

Implementations§

Source§

impl EventLog

Source

pub fn disabled() -> Self

A disabled log: Self::record is a no-op that writes nothing.

Source

pub fn new(path: impl Into<PathBuf>) -> Self

An enabled log pinned to a specific JSONL file path.

Source

pub fn from_env() -> Self

Resolve from the environment.

Enabled iff AUTH_CLOUDFLARE_OBSERVABILITY is exactly "1". The log path is AUTH_CLOUDFLARE_EVENT_LOG when set, otherwise ~/.hermes/auth-cloudflare/events.jsonl (respecting HERMES_HOME). Any other value - including unset - yields a disabled no-op log.

Source

pub fn is_enabled(&self) -> bool

True when events will actually be written.

Source

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

The log file path, when enabled.

Source

pub fn record(&self, event: Event) -> Result<(), Error>

Append one event as a single JSON line.

No-op (returns Ok(())) when disabled. When enabled, the parent directory is created if needed, the file is opened in append mode, and the JSON object plus trailing newline is written in a single write_all. The file is created user-private (mode 0o600 on Unix).

Trait Implementations§

Source§

impl Clone for EventLog

Source§

fn clone(&self) -> EventLog

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 EventLog

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