Skip to main content

StepRecord

Struct StepRecord 

Source
pub struct StepRecord {
Show 16 fields pub spec: StepSpecRecord, pub program: Option<ProgramPath>, pub observations: Vec<Observation>, pub ignored: u64, pub exit: StepExit, pub output: RecordedOutput, pub duration_nanos: u64, pub ran_at_nanos: u64, pub reason: RunReason, pub recorded_at_nanos: u64, pub failure: Option<String>, pub not_cached: Option<NotCachedReason>, pub owners: BTreeSet<TaskId>, pub unknown_system_calls: Vec<u32>, pub connections: Vec<Connection>, pub machine: MachineStateRecord,
}
Expand description

What is recorded about one run of a step, by step key, and the tasks that own the record.

Fields§

§spec: StepSpecRecord

The full step specification.

§program: Option<ProgramPath>

The program that ran, after the lookup through PATH, or None when no program was found.

§observations: Vec<Observation>

Every touched path that no ignore pattern matched, sorted by path, with its state when the step finished, or when a cache check last refreshed it.

§ignored: u64

The number of touched paths that ignore patterns left out.

§exit: StepExit

How the command ended.

§output: RecordedOutput

The raw captured output.

§duration_nanos: u64

How long the command ran, in nanoseconds.

§ran_at_nanos: u64

When the command ran, in nanoseconds since the Unix epoch.

§reason: RunReason

Why the step ran.

§recorded_at_nanos: u64

When kizz began writing the observations, before it read the state of any path, in nanoseconds since the Unix epoch. A cache check that refreshes the observations moves it to when that check began. A recorded modification time within two seconds of it cannot prove a file unchanged.

§failure: Option<String>

For a program that was missing or not executable, the message of the task failure, which a cache hit fails with again; for a command that could not start, the message of its task failure.

§not_cached: Option<NotCachedReason>

Why the result of the run was not cached, or None when it was.

A record with a reason here is never a cache hit: it replaces any older record of the step key, so no older result is replayed, and the next build runs the step again with this reason.

§owners: BTreeSet<TaskId>

The tasks that own the record, without repeats: every task that produced it or used it, by its TaskId, the absolute path of its kizz.md and the index of its block in the file.

The owners belong to the record of the step key, not to one run: a run of a task whose identity the engine knows adds the task and keeps the owners of the record it replaces, and a step that its task notes as cached adds the task. A path reset (kizz cache reset PATH) removes the record only when every owner is a task under the path, and otherwise only takes those tasks out; kizz cache clean takes out the tasks whose kizz.md no longer exists. A record with no owner is no task’s entry, so no path reset changes it.

§unknown_system_calls: Vec<u32>

The number of each system call that the command made and that the tracer does not know, sorted and without repeats, whether the result was cached or not: kizz build --cache-unknown-syscalls caches such a result, and without it the record is marked with NotCachedReason::UnknownSystemCalls unless another reason applies.

§connections: Vec<Connection>

Every connection that the command made to an IPv4 or IPv6 address or to a Unix socket, sorted and without repeats, whether the result was cached or not. Connections never keep a result out of the cache.

§machine: MachineStateRecord

The machine and process state that the command started with, which the engine queries right before it looks the program up and runs it, whether or not the step names any part of it.

Trait Implementations§

Source§

impl Clone for StepRecord

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 StepRecord

Source§

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

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

impl<'bytes, Ctx> Decode<'bytes, Ctx> for StepRecord

Source§

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx, ) -> Result<StepRecord, Error>

Decode a value using the given Decoder. Read more
§

fn nil() -> Option<Self>

If possible, return a nil value of Self. Read more
Source§

impl<Ctx> Encode<Ctx> for StepRecord

Source§

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx, ) -> Result<(), Error<__W777::Error>>
where __W777: Write,

Encode a value of this type using the given Encoder. Read more
§

fn is_nil(&self) -> bool

Is this value of Self a nil value? Read more
Source§

impl Eq for StepRecord

Source§

impl PartialEq for StepRecord

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Record for StepRecord

Source§

const FAMILY: Family = Family::Step

The family of this record type.
Source§

type Key = StepKey

The key of a record of this type.
Source§

impl StructuralPartialEq for StepRecord

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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