Struct ShardPlan 

pub struct ShardPlan {
    pub file: String,
    pub files: usize,
    pub first: String,
    pub last: String,
    pub bytes: u64,
    pub tokens: u64,
}

One planned shard: a Markdown file of the pack, the paths it carries from first to last, and what it weighs in bytes and in tokens.

The examples below plan a repository holding main.rs and a logo.png whose content is binary, with a distribution whose chat profile has limits and whose bare one has none.

use majordomus_cli::pack::{plan, ShardPlan};
let planned = plan(&root, &share, None);
let first: &ShardPlan = &planned.plan.shards[0];
assert_eq!((first.files, first.first.as_str(), first.last.as_str()), (1, "main.rs", "main.rs"));
assert!(first.file.ends_with(".md") && first.tokens > 0);

Fields

file: String

The file name inside the pack.

files: usize

How many files it carries.

first: String

The first path it carries.

last: String

The last path it carries.

bytes: u64

The bytes of the content it carries.

tokens: u64

The tokens of the blocks it carries.

Trait Implementations

impl Clone for ShardPlan

fn clone(&self) -> ShardPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShardPlan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShardPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ShardPlan

impl JsonSchema for ShardPlan

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 ShardPlan

fn eq(&self, other: &ShardPlan) -> 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 ShardPlan

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 ShardPlan