Struct FunctionParameterInfo 

pub struct FunctionParameterInfo {
    pub name: String,
    pub type_text: String,
    pub type_json: Option<String>,
    pub type_name: i32,
    pub type_precision: Option<i32>,
    pub type_scale: Option<i32>,
    pub type_interval_type: Option<String>,
    pub position: Option<i32>,
    pub parameter_mode: i32,
    pub parameter_type: i32,
    pub parameter_default: Option<String>,
    pub comment: Option<String>,
}

Information about a single function parameter.

Fields

name: String

Name of parameter.

type_text: String

Full data type specification as SQL/catalogString text.

type_json: Option<String>

Full data type specification, JSON-serialized.

type_name: i32

Data type name.

type_precision: Option<i32>

Digits of precision; required for DecimalTypes.

type_scale: Option<i32>

Digits to right of decimal; required for DecimalTypes.

type_interval_type: Option<String>

Format of IntervalType.

position: Option<i32>

Ordinal position of column (starting at position 0).

parameter_mode: i32

The mode of the function parameter.

parameter_type: i32

The type of function parameter.

parameter_default: Option<String>

Default value of the parameter.

comment: Option<String>

User-provided free-form text description.

Implementations

impl FunctionParameterInfo

pub fn type_json(&self) -> &str

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

pub fn type_name(&self) -> ColumnTypeName

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

pub fn set_type_name(&mut self, value: ColumnTypeName)

Sets type_name to the provided enum value.

pub fn type_precision(&self) -> i32

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

pub fn type_scale(&self) -> i32

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

pub fn type_interval_type(&self) -> &str

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

pub fn position(&self) -> i32

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

pub fn parameter_mode(&self) -> ParameterMode

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

pub fn set_parameter_mode(&mut self, value: ParameterMode)

Sets parameter_mode to the provided enum value.

pub fn parameter_type(&self) -> FunctionParameterType

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

pub fn set_parameter_type(&mut self, value: FunctionParameterType)

Sets parameter_type to the provided enum value.

pub fn parameter_default(&self) -> &str

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

pub fn comment(&self) -> &str

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

Trait Implementations

impl Clone for FunctionParameterInfo

fn clone(&self) -> FunctionParameterInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionParameterInfo

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

Formats the value using the given formatter.

impl Default for FunctionParameterInfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionParameterInfo

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FunctionParameterInfo

impl Hash for FunctionParameterInfo

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 Message for FunctionParameterInfo

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 FunctionParameterInfo

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FunctionParameterInfo

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionParameterInfo