Enum InstanceView

#[repr(i32)]
pub enum InstanceView {
    Unspecified = 0,
    Basic = 1,
    Full = 2,
}

View on Instance. Pass this enum to rpcs that returns an Instance message to control which subsets of fields to get.

Variants

Unspecified = 0

INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.

Basic = 1

BASIC server responses for a primary or read instance include all the relevant instance details, excluding the details of each node in the instance. The default value.

Full = 2

FULL response is equivalent to BASIC for primary instance (for now). For read pool instance, this includes details of each node in the pool.

Implementations

impl InstanceView

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of InstanceView.

pub fn from_i32(value: i32) -> Option<InstanceView>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a InstanceView, or None if value is not a valid variant.

impl InstanceView

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for InstanceView

fn clone(&self) -> InstanceView

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceView

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

Formats the value using the given formatter.

impl Default for InstanceView

fn default() -> InstanceView

Returns the “default value” for a type.

impl From<InstanceView> for i32

fn from(value: InstanceView) -> i32

Converts to this type from the input type.

impl Hash for InstanceView

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InstanceView

fn cmp(&self, other: &InstanceView) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InstanceView

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

fn partial_cmp(&self, other: &InstanceView) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for InstanceView

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<InstanceView, UnknownEnumValue>

Performs the conversion.

impl Copy for InstanceView

impl Eq for InstanceView

impl StructuralPartialEq for InstanceView