#[non_exhaustive]pub struct GraphDataSummary {Show 14 fields
pub num_nodes: Option<i64>,
pub num_edges: Option<i64>,
pub num_node_labels: Option<i64>,
pub num_edge_labels: Option<i64>,
pub node_labels: Option<Vec<String>>,
pub edge_labels: Option<Vec<String>>,
pub num_node_properties: Option<i64>,
pub num_edge_properties: Option<i64>,
pub node_properties: Option<Vec<HashMap<String, i64>>>,
pub edge_properties: Option<Vec<HashMap<String, i64>>>,
pub total_node_property_values: Option<i64>,
pub total_edge_property_values: Option<i64>,
pub node_structures: Option<Vec<NodeStructure>>,
pub edge_structures: Option<Vec<EdgeStructure>>,
}
Expand description
Summary information about the graph.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.num_nodes: Option<i64>
The number of nodes in the graph.
num_edges: Option<i64>
The number of edges in the graph.
num_node_labels: Option<i64>
The number of distinct node labels in the graph.
num_edge_labels: Option<i64>
The number of unique edge labels in the graph.
node_labels: Option<Vec<String>>
A list of distinct node labels in the graph.
edge_labels: Option<Vec<String>>
A list of the edge labels in the graph.
num_node_properties: Option<i64>
The number of distinct node properties in the graph.
num_edge_properties: Option<i64>
The number of edge properties in the graph.
node_properties: Option<Vec<HashMap<String, i64>>>
A list of the distinct node properties in the graph, along with the count of nodes where each property is used.
edge_properties: Option<Vec<HashMap<String, i64>>>
A list of the distinct edge properties in the graph, along with the count of edges where each property is used.
total_node_property_values: Option<i64>
The total number of usages of all node properties.
total_edge_property_values: Option<i64>
The total number of usages of all edge properties.
node_structures: Option<Vec<NodeStructure>>
This field is only present when the requested mode is DETAILED. It contains a list of node structures.
edge_structures: Option<Vec<EdgeStructure>>
This field is only present when the requested mode is DETAILED. It contains a list of edge structures.
Implementations§
Source§impl GraphDataSummary
impl GraphDataSummary
Sourcepub fn num_node_labels(&self) -> Option<i64>
pub fn num_node_labels(&self) -> Option<i64>
The number of distinct node labels in the graph.
Sourcepub fn num_edge_labels(&self) -> Option<i64>
pub fn num_edge_labels(&self) -> Option<i64>
The number of unique edge labels in the graph.
Sourcepub fn node_labels(&self) -> &[String]
pub fn node_labels(&self) -> &[String]
A list of distinct node labels in the graph.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .node_labels.is_none()
.
Sourcepub fn edge_labels(&self) -> &[String]
pub fn edge_labels(&self) -> &[String]
A list of the edge labels in the graph.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .edge_labels.is_none()
.
Sourcepub fn num_node_properties(&self) -> Option<i64>
pub fn num_node_properties(&self) -> Option<i64>
The number of distinct node properties in the graph.
Sourcepub fn num_edge_properties(&self) -> Option<i64>
pub fn num_edge_properties(&self) -> Option<i64>
The number of edge properties in the graph.
Sourcepub fn node_properties(&self) -> &[HashMap<String, i64>]
pub fn node_properties(&self) -> &[HashMap<String, i64>]
A list of the distinct node properties in the graph, along with the count of nodes where each property is used.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .node_properties.is_none()
.
Sourcepub fn edge_properties(&self) -> &[HashMap<String, i64>]
pub fn edge_properties(&self) -> &[HashMap<String, i64>]
A list of the distinct edge properties in the graph, along with the count of edges where each property is used.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .edge_properties.is_none()
.
Sourcepub fn total_node_property_values(&self) -> Option<i64>
pub fn total_node_property_values(&self) -> Option<i64>
The total number of usages of all node properties.
Sourcepub fn total_edge_property_values(&self) -> Option<i64>
pub fn total_edge_property_values(&self) -> Option<i64>
The total number of usages of all edge properties.
Sourcepub fn node_structures(&self) -> &[NodeStructure]
pub fn node_structures(&self) -> &[NodeStructure]
This field is only present when the requested mode is DETAILED. It contains a list of node structures.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .node_structures.is_none()
.
Sourcepub fn edge_structures(&self) -> &[EdgeStructure]
pub fn edge_structures(&self) -> &[EdgeStructure]
This field is only present when the requested mode is DETAILED. It contains a list of edge structures.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .edge_structures.is_none()
.
Source§impl GraphDataSummary
impl GraphDataSummary
Sourcepub fn builder() -> GraphDataSummaryBuilder
pub fn builder() -> GraphDataSummaryBuilder
Creates a new builder-style object to manufacture GraphDataSummary
.
Trait Implementations§
Source§impl Clone for GraphDataSummary
impl Clone for GraphDataSummary
Source§fn clone(&self) -> GraphDataSummary
fn clone(&self) -> GraphDataSummary
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GraphDataSummary
impl Debug for GraphDataSummary
Source§impl PartialEq for GraphDataSummary
impl PartialEq for GraphDataSummary
impl StructuralPartialEq for GraphDataSummary
Auto Trait Implementations§
impl Freeze for GraphDataSummary
impl RefUnwindSafe for GraphDataSummary
impl Send for GraphDataSummary
impl Sync for GraphDataSummary
impl Unpin for GraphDataSummary
impl UnwindSafe for GraphDataSummary
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);