Skip to main content

Baseline

Struct Baseline 

Source
pub struct Baseline {
    pub note: String,
    pub format: u32,
    pub source: Source,
    pub base_event_fields: Vec<Field>,
    pub event_types: Vec<String>,
    pub events: Vec<Event>,
}

Fields§

§note: String§format: u32§source: Source§base_event_fields: Vec<Field>

Fields every event inherits from BaseEventSchema. Kept out of the per-event field lists, where they would be repeated 36 times, and compared once against the Rust BaseEvent instead.

§event_types: Vec<String>

EventType values in upstream declaration order.

§events: Vec<Event>

One entry per event type, same order.

Implementations§

Source§

impl Baseline

Source

pub fn from_upstream(up: &Upstream, source: Source) -> Self

Builds a baseline from a freshly extracted upstream surface.

Source

pub fn load(path: &Path) -> Result<Self, String>

Source

fn validate(&self) -> Result<(), String>

Refuses to persist a snapshot that cannot do the job of a baseline.

--refresh replaces a human-reviewed file with whatever came back over the network, and the dangerous failure is not a loud one. A response truncated after the EventType enum but before the schemas parses perfectly well: every event type is still found, every schema is recorded unparsed, and because unparsed schemas are deliberately warnings rather than failures, the resulting baseline agrees with any Rust source at all. The gate would go quiet instead of going red, which is the one outcome this crate exists to prevent.

So a baseline must name at least one event type, carry one entry per event type, and have read a majority of the schemas. A healthy capture reads all of them; half is slack for upstream reformatting, not for a half-delivered file.

Source

pub fn save(&self, path: &Path) -> Result<(), String>

Source

pub fn event(&self, event_type: &str) -> Option<&Event>

Trait Implementations§

Source§

impl Clone for Baseline

Source§

fn clone(&self) -> Baseline

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 Baseline

Source§

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

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

impl<'de> Deserialize<'de> for Baseline

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Baseline

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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