Struct Study 

pub struct Study {
    pub name: String,
    pub display_name: String,
    pub study_spec: Option<StudySpec>,
    pub state: i32,
    pub create_time: Option<Timestamp>,
    pub inactive_reason: String,
}

A message representing a Study.

Fields

name: String

The name of a study. The study’s globally unique identifier. Format: owners/{owner_id}/studies/{study_id}

display_name: String

Describes the Study, default value is empty string.

study_spec: Option<StudySpec>

Configuration of the Study.

state: i32

The detailed state of a Study.

create_time: Option<Timestamp>

Time at which the study was created.

inactive_reason: String

A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

Implementations

impl Study

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Study

fn clone(&self) -> Study

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Study

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

Formats the value using the given formatter.

impl Default for Study

fn default() -> Self

Returns the “default value” for a type.

impl Message for Study

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Study

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

fn to_study_name(&self) -> StudyName

Converts this object to a StudyName.

impl StructuralPartialEq for Study