Struct ColumnFamily 

#[non_exhaustive]
pub struct ColumnFamily {
    pub gc_rule: Option<GcRule>,
    pub value_type: Option<Type>,
    /* private fields */
}

A set of columns within a table which share a common configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gc_rule: Option<GcRule>

Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes.

NOTE: Garbage collection executes opportunistically in the background, and so it’s possible for reads to return a cell even if it matches the active GC expression for its family.

value_type: Option<Type>

The type of data stored in each of this family’s cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

For now, only the Aggregate type is supported.

Aggregate can only be set at family creation and is immutable afterwards.

If value_type is Aggregate, written data must be compatible with:

• value_type.input_type for AddInput mutations

Implementations

impl ColumnFamily

pub fn new() -> Self

pub fn set_gc_rule<T>(self, v: T) -> Self

where T: Into<GcRule>,

Sets the value of gc_rule.

Example

use google_cloud_bigtable_admin_v2::model::GcRule;
let x = ColumnFamily::new().set_gc_rule(GcRule::default()/* use setters */);

pub fn set_or_clear_gc_rule<T>(self, v: Option<T>) -> Self

where T: Into<GcRule>,

Sets or clears the value of gc_rule.

Example

use google_cloud_bigtable_admin_v2::model::GcRule;
let x = ColumnFamily::new().set_or_clear_gc_rule(Some(GcRule::default()/* use setters */));
let x = ColumnFamily::new().set_or_clear_gc_rule(None::<GcRule>);

pub fn set_value_type<T>(self, v: T) -> Self

where T: Into<Type>,

Sets the value of value_type.

Example

use google_cloud_bigtable_admin_v2::model::Type;
let x = ColumnFamily::new().set_value_type(Type::default()/* use setters */);

pub fn set_or_clear_value_type<T>(self, v: Option<T>) -> Self

where T: Into<Type>,

Sets or clears the value of value_type.

Example

use google_cloud_bigtable_admin_v2::model::Type;
let x = ColumnFamily::new().set_or_clear_value_type(Some(Type::default()/* use setters */));
let x = ColumnFamily::new().set_or_clear_value_type(None::<Type>);

Trait Implementations

impl Clone for ColumnFamily

fn clone(&self) -> ColumnFamily

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnFamily

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

Formats the value using the given formatter.

impl Default for ColumnFamily

fn default() -> ColumnFamily

Returns the “default value” for a type.

impl Message for ColumnFamily

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ColumnFamily

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