Skip to main content

Condensate

Struct Condensate 

Source
pub struct Condensate {
    pub schema: SchemaId,
    pub payload: CondensatePayload,
    pub raw: Digest,
    pub cap: usize,
    pub lossy: bool,
    pub slicer: SlicerId,
}
Expand description

κ — an AST-preserved, size-capped, high-density summary of a result.

§Example

use boundgraph_core::{Condensate, CondensatePayload, Digest, SchemaId, SlicerId};

let raw = b"...ten thousand lines of build output...";

let k = Condensate::new(
    SchemaId::new("boundgraph.log.v1", 1),
    CondensatePayload::inline(&"3 errors, first at src/main.rs:42")?,
    Digest::of(raw),      // the original is still addressable
    400,                  // the cap that was applied
    true,                 // slicing dropped information
    SlicerId::new("log", 1),
);

assert!(k.lossy);
assert_eq!(k.raw, Digest::of(raw));

Fields§

§schema: SchemaId

The shape of payload. A condensate is typed, never a bare blob of text.

§payload: CondensatePayload

The summary itself, inline or stored.

§raw: Digest

The complete, unmodified output this was derived from.

Always present, even when nothing was dropped, so an auditor never has to ask whether the original still exists.

§cap: usize

The token cap actually applied when slicing.

§lossy: bool

Whether slicing dropped information.

Set honestly by the slicer. A consumer that needs completeness must check this rather than assume.

§slicer: SlicerId

Which slicer produced this, and at what version.

Implementations§

Source§

impl Condensate

Source

pub fn new( schema: SchemaId, payload: CondensatePayload, raw: Digest, cap: usize, lossy: bool, slicer: SlicerId, ) -> Self

Construct a condensate.

Source

pub fn needs_raw_for_completeness(&self) -> bool

Whether the full original must be fetched to see everything.

Equivalent to lossy, named for the question a caller actually has.

Source

pub const fn raw_digest(&self) -> &Digest

Where to find the complete output.

Trait Implementations§

Source§

impl Clone for Condensate

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 Condensate

Source§

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

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

impl<'de> Deserialize<'de> for Condensate

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 PartialEq for Condensate

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 Serialize for Condensate

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

impl StructuralPartialEq for Condensate

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> Canonical for T
where T: Serialize + ?Sized,

Source§

fn canonical_bytes(&self) -> Result<Vec<u8>, CanonicalError>

The canonical CBOR encoding of this value.
Source§

fn digest(&self) -> Result<Digest, CanonicalError>

The blake3 digest of this value’s canonical encoding.
Source§

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

Source§

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
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

Source§

fn vzip(self) -> V