Struct Profile 

pub struct Profile {
    pub name: Option<String>,
    /* private fields */
}

A profile of rows. See the module docs.

Fields

name: Option<String>

What was profiled (a file name), for the heading.

Implementations

impl Profile

pub fn of(rows: &Rows) -> Self

A profile of rows in memory, with the default options.

pub fn from_source( source: impl RowSource, options: ProfileOptions, ) -> Result<Self, DataError>

Profile every row of source, stopping at the first that cannot be read.

pub fn with_name(self, name: impl Into<String>) -> Self

Name what was profiled, for the heading.

pub fn note(&mut self, note: impl Into<String>)

Add a note shown under the heading (rows cut to fit, keys seen late).

pub fn rows(&self) -> u64

Every row read.

pub fn sample_size(&self) -> usize

The rows the types, statistics and distributions describe.

pub fn sampled(&self) -> bool

Whether the sample is fewer rows than were read.

pub fn columns(&self) -> &[ColumnProfile]

One entry per column, in order.

pub fn column(&self, name: &str) -> Option<&ColumnProfile>

The column called name.

pub fn missing(&self) -> &MissingMap

Where the nulls are.

pub fn notes(&self) -> &[String]

The notes, in order.

pub fn to_json(&self) -> Value

The profile as JSON: rows, sample, sampled, columns, missing, and name and notes when set.

pub fn heading(&self) -> String

The heading: the name, the rows (and the sample, when smaller) and the columns.

pub fn to_table(&self) -> Table

The table of columns: type, nulls, distinct, min, max and mean (the median and quartiles are in the model and under each numeric column’s heading).

pub fn missing_heatmap(&self) -> Option<Heatmap>

The missing-value map as a heatmap: a row per bucket, a column per column, each cell the percentage of the bucket’s cells that are null. None when nothing is null.

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Profile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Profile

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

Equality operator ==.

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

Inequality operator !=.

impl Renderable for Profile

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

As wide as its widest line at the width given.

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

impl Serialize for Profile

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 Profile