Struct google_api_proto::google::ai::generativelanguage::v1beta::CitationSource

pub struct CitationSource {
    pub start_index: Option<i32>,
    pub end_index: Option<i32>,
    pub uri: Option<String>,
    pub license: Option<String>,
}

A citation to a source for a portion of a specific response.

Fields

start_index: Option<i32>

Optional. Start of segment of the response that is attributed to this source.

Index indicates the start of the segment, measured in bytes.

end_index: Option<i32>

Optional. End of the attributed segment, exclusive.

uri: Option<String>

Optional. URI that is attributed as a source for a portion of the text.

license: Option<String>

Optional. License for the GitHub project that is attributed as a source for segment.

License info is required for code citations.

Implementations

impl CitationSource

pub fn start_index(&self) -> i32

Returns the value of start_index, or the default value if start_index is unset.

pub fn end_index(&self) -> i32

Returns the value of end_index, or the default value if end_index is unset.

pub fn uri(&self) -> &str

Returns the value of uri, or the default value if uri is unset.

pub fn license(&self) -> &str

Returns the value of license, or the default value if license is unset.

Trait Implementations

impl Clone for CitationSource

fn clone(&self) -> CitationSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CitationSource

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

Formats the value using the given formatter.

impl Default for CitationSource

fn default() -> Self

Returns the “default value” for a type.

impl Message for CitationSource

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 CitationSource

fn eq(&self, other: &CitationSource) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CitationSource