Struct PackVerdict 

pub struct PackVerdict {
    pub measured: bool,
    pub reason: Option<String>,
    pub dir: String,
    pub profile: Option<String>,
    pub commit: Option<String>,
    pub files: usize,
    pub sources: usize,
    pub largest_tokens: u64,
    pub findings: Vec<PackFinding>,
    pub passes: bool,
}

The verdict on a written pack: whether it could be read, what its manifest names, how many files and sources it holds, and every finding against it.

The examples below build a pack of a repository holding main.rs.

use majordomus_cli::pack::{build, plan, verify, PackVerdict, Profiles};
let profiles = Profiles::load(&share, &root).unwrap();
let out = dir.path().join("pack");
let v: PackVerdict = build(&plan(&root, &share, None), &root, &out).unwrap();
assert_eq!((v.files, v.sources), (2, 1), "the index and one shard, carrying one file");
assert_eq!(v.profile.as_deref(), Some("chat"));
// a directory with no manifest is not measured, which is not a pass
let v: PackVerdict = verify(dir.path(), &profiles, &root);
assert!(!v.measured && !v.passes);

Fields

measured: bool

Whether the pack could be read at all. false is not a pass.

reason: Option<String>

Why it could not, when it could not.

dir: String

The directory read.

profile: Option<String>

The profile its manifest names.

commit: Option<String>

The commit its manifest names.

files: usize

How many files it holds, the index included.

sources: usize

How many source files its shards carry.

largest_tokens: u64

The tokens of its largest file.

findings: Vec<PackFinding>

Every finding. Empty is the passing answer.

passes: bool

true when the pack was read and nothing was found.

Trait Implementations

impl Clone for PackVerdict

fn clone(&self) -> PackVerdict

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PackVerdict

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackVerdict

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PackVerdict

impl JsonSchema for PackVerdict

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PackVerdict

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PackVerdict

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PackVerdict