Struct datafusion_physical_plan::metrics::Gauge

pub struct Gauge { /* private fields */ }

A gauge is the simplest metrics type. It just returns a value. For example, you can easily expose current memory consumption with a gauge.

Note cloneing gauge update the same underlying metrics

Implementations

impl Gauge

pub fn new() -> Self

create a new gauge

pub fn add(&self, n: usize)

Add n to the metric’s value

pub fn sub(&self, n: usize)

Sub n from the metric’s value

pub fn set_max(&self, n: usize)

Set metric’s value to maximum of n and current value

pub fn set(&self, n: usize) -> usize

Set the metric’s value to n and return the previous value

pub fn value(&self) -> usize

Get the current value

Trait Implementations

impl Clone for Gauge

fn clone(&self) -> Gauge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gauge

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

Formats the value using the given formatter.

impl Default for Gauge

fn default() -> Self

Returns the “default value” for a type.

impl Display for Gauge

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

Formats the value using the given formatter.

impl PartialEq for Gauge

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