Struct FunctionParameterInfo 

pub struct FunctionParameterInfo {
    pub name: String,
    pub type_text: String,
    pub type_json: Option<String>,
    pub type_name: EnumValue<ColumnTypeName>,
    pub type_precision: Option<i32>,
    pub type_scale: Option<i32>,
    pub type_interval_type: Option<String>,
    pub position: Option<i32>,
    pub parameter_mode: EnumValue<ParameterMode>,
    pub parameter_type: EnumValue<FunctionParameterType>,
    pub parameter_default: Option<String>,
    pub comment: Option<String>,
    /* private fields */
}

Information about a single function parameter.

Fields

name: String

Name of parameter.

Field 1: name

type_text: String

Full data type specification as SQL/catalogString text.

Field 2: type_text

type_json: Option<String>

Full data type specification, JSON-serialized.

Field 3: type_json

type_name: EnumValue<ColumnTypeName>

Data type name.

Field 4: type_name

type_precision: Option<i32>

Digits of precision; required for DecimalTypes.

Field 5: type_precision

type_scale: Option<i32>

Digits to right of decimal; required for DecimalTypes.

Field 6: type_scale

type_interval_type: Option<String>

Format of IntervalType.

Field 7: type_interval_type

position: Option<i32>

Ordinal position of column (starting at position 0).

Field 8: position

parameter_mode: EnumValue<ParameterMode>

The mode of the function parameter.

Field 9: parameter_mode

parameter_type: EnumValue<FunctionParameterType>

The type of function parameter.

Field 10: parameter_type

parameter_default: Option<String>

Default value of the parameter.

Field 11: parameter_default

comment: Option<String>

User-provided free-form text description.

Field 12: comment

Implementations

impl FunctionParameterInfo

pub const TYPE_URL: &'static str = "type.googleapis.com/unitycatalog.functions.v1.FunctionParameterInfo"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

impl FunctionParameterInfo

pub fn with_type_json(self, value: impl Into<String>) -> Self

Sets Self::type_json to Some(value), consuming and returning self.

pub fn with_type_precision(self, value: i32) -> Self

Sets Self::type_precision to Some(value), consuming and returning self.

pub fn with_type_scale(self, value: i32) -> Self

Sets Self::type_scale to Some(value), consuming and returning self.

pub fn with_type_interval_type(self, value: impl Into<String>) -> Self

Sets Self::type_interval_type to Some(value), consuming and returning self.

pub fn with_position(self, value: i32) -> Self

Sets Self::position to Some(value), consuming and returning self.

pub fn with_parameter_default(self, value: impl Into<String>) -> Self

Sets Self::parameter_default to Some(value), consuming and returning self.

pub fn with_comment(self, value: impl Into<String>) -> Self

Sets Self::comment to Some(value), consuming and returning self.

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() -> FunctionParameterInfo

Returns the “default value” for a type.

impl DefaultInstance for FunctionParameterInfo

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

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

where FunctionParameterInfo: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtensionSet for FunctionParameterInfo

const PROTO_FQN: &'static str = "unitycatalog.functions.v1.FunctionParameterInfo"

Fully-qualified proto type name of this message (no leading dot), e.g. "google.protobuf.FieldOptions".

fn unknown_fields(&self) -> &UnknownFields

Immutable access to the extendee’s unknown-field storage.

fn unknown_fields_mut(&mut self) -> &mut UnknownFields

Mutable access to the extendee’s unknown-field storage.

fn extension<C>(&self, ext: &Extension<C>) -> <C as ExtensionCodec>::Output

where C: ExtensionCodec,

Read an extension value.

fn set_extension<C>( &mut self, ext: &Extension<C>, value: <C as ExtensionCodec>::Value, )

where C: ExtensionCodec,

Write an extension value, replacing any prior occurrences.

fn has_extension<C>(&self, ext: &Extension<C>) -> bool

where C: ExtensionCodec,

Returns true if any record at the extension’s field number is present.

fn clear_extension<C>(&mut self, ext: &Extension<C>)

where C: ExtensionCodec,

Remove all records at the extension’s field number.

fn extension_or_default<C>( &self, ext: &Extension<C>, ) -> <C as ExtensionCodec>::Value

where C: ExtensionCodec<Output = Option<<C as ExtensionCodec>::Value>>, <C as ExtensionCodec>::Value: Default,

Read a singular extension value, returning the proto2 [default = ...] value if absent, or the type’s Default if no proto default was declared.

impl HasMessageView for FunctionParameterInfo

type View<'a> = FunctionParameterInfoView<'a>

The zero-copy view of Self, borrowing from a buffer with lifetime 'a.

type ViewHandle = FunctionParameterInfoOwnedView

The generated 'static owned-view handle for Self (FooOwnedView).

fn decode_view_handle(bytes: Bytes) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle from a Bytes buffer.

fn decode_view_handle_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle with custom DecodeOptions (recursion limit, max message size).

impl Message for FunctionParameterInfo

fn compute_size(&self, _cache: &mut SizeCache) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, _cache: &mut SizeCache, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer, consuming nested-message sizes from cache (populated by a prior compute_size call on the same cache).

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, depth: u32, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Compute size, then write. This is the primary encoding API.

fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)

Encode using a caller-supplied SizeCache, for reuse across many encodes in a hot loop. Clears the cache first.

fn encoded_len(&self) -> u32

Compute the encoded byte size of this message.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

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

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

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

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

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

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, depth: u32, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, depth: u32, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

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

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

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

Merge fields from a length-delimited sub-message payload into this message.

impl MessageName for FunctionParameterInfo

const PACKAGE: &'static str = "unitycatalog.functions.v1"

The protobuf package the message is declared in.

const NAME: &'static str = "FunctionParameterInfo"

The unqualified message name, with . between nesting levels.

const FULL_NAME: &'static str = "unitycatalog.functions.v1.FunctionParameterInfo"

The fully-qualified protobuf type name with no leading dot.

const TYPE_URL: &'static str = "type.googleapis.com/unitycatalog.functions.v1.FunctionParameterInfo"

The google.protobuf.Any.type_url form for this message.

impl PartialEq for FunctionParameterInfo

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

Equality operator ==.

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

Inequality operator !=.

impl ProtoElemJson for FunctionParameterInfo

fn serialize_proto_json<S: Serializer>( v: &Self, s: S, ) -> Result<S::Ok, S::Error>

Serialize this value with proto3 JSON semantics.

fn deserialize_proto_json<'de, D: Deserializer<'de>>( d: D, ) -> Result<Self, D::Error>

Deserialize a value with proto3 JSON semantics.

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