commit_token

Stable type · Streaming writer

Tier: stable · Kind: type · Topic: Streaming writer

Python	Julia	Rust
not exported	`CommitToken`	`CommitToken`

Python

Python does not export this type.

Julia

struct CommitToken
CommitToken(writer::Int64, region::Vector{Pair{String, Tuple{Int64, Int64}}}, fingerprint::String, records::Vector{Tuple{Int64, Float64}}, statics::Vector{String}, blobs::Vector{Tuple{String, Union{Nothing, Int64}, String}}, objects::Vector{String})
CommitToken(writer, region, fingerprint, records, statics, blobs, objects)

CommitToken

What one writer wrote since its previous token (spec/writer.md §5.2), returned by [write_flush!] and handed (by the caller — EarthSciIO is MPI-free) to the owner’s [write_commit!]/[write_close!]. Fields: writer id, its region (dim => (start, stop)), the schema fingerprint, records ((index, t), ascending), statics (names, sorted), blobs ((scope, record, key), sorted; record is nothing for scope "static") and the advisory objects (store keys PUT, sorted). [token_json]/[parse_token] are its documented JSON form.

Source

Rust

pub struct CommitToken {
    pub schema: String,
    pub writer: usize,
    pub region: BTreeMap<String, [usize; 2]>,
    pub fingerprint: String,
    pub records: Vec<TokenRecord>,
    pub statics: Vec<String>,
    pub blobs: Vec<TokenBlob>,
    pub objects: Vec<String>,
}

impl CommitToken { pub fn to_json(&self) -> String }

impl CommitToken { pub fn from_json(s: &str) -> Result<Self> }

impl CommitToken { pub fn is_empty(&self) -> bool }

The value a writer hands the owner after flush (spec/writer.md §5.2). Serializes to the documented JSON wire format.

Source · Rust docs