Struct Opaque 

pub struct Opaque(/* private fields */);

The extension type for Opaque.

Extension name: arrow.opaque.

Opaque represents a type that an Arrow-based system received from an external (often non-Arrow) system, but that it cannot interpret. In this case, it can pass on Opaque to its clients to at least show that a field exists and preserve metadata about the type from the other system.

The storage type of this extension is any type. If there is no underlying data, the storage type should be Null.

Implementations

impl Opaque

pub fn new(type_name: impl Into<String>, vendor_name: impl Into<String>) -> Self

Available on crate feature canonical_extension_types only.

Returns a new Opaque extension type.

pub fn type_name(&self) -> &str

Available on crate feature canonical_extension_types only.

Returns the name of the unknown type in the external system.

pub fn vendor_name(&self) -> &str

Available on crate feature canonical_extension_types only.

Returns the name of the external system.

Trait Implementations

impl Clone for Opaque

Available on crate feature canonical_extension_types only.

fn clone(&self) -> Opaque

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Opaque

Available on crate feature canonical_extension_types only.

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

Formats the value using the given formatter.

impl ExtensionType for Opaque

Available on crate feature canonical_extension_types only.

const NAME: &'static str = "arrow.opaque"

The name identifying this extension type.

type Metadata = OpaqueMetadata

The metadata type of this extension type.

fn metadata(&self) -> &Self::Metadata

Returns a reference to the metadata of this extension type, or &() if if this extension type defines no metadata (Self::Metadata=()).

fn serialize_metadata(&self) -> Option<String>

Returns the serialized representation of the metadata of this extension type, or None if this extension type defines no metadata (Self::Metadata=()).

fn deserialize_metadata( metadata: Option<&str>, ) -> Result<Self::Metadata, ArrowError>

Deserialize the metadata of this extension type from the serialized representation of the metadata. An extension type that defines no metadata should expect None for the serialized metadata and return Ok(()).

fn supports_data_type(&self, _data_type: &DataType) -> Result<(), ArrowError>

Returns Ok(()) iff the given data type is supported by this extension type.

fn try_new( _data_type: &DataType, metadata: Self::Metadata, ) -> Result<Self, ArrowError>

Construct this extension type for a field with the given data type and metadata.

impl From<Opaque> for CanonicalExtensionType

Available on crate feature canonical_extension_types only.

fn from(value: Opaque) -> Self

Converts to this type from the input type.

impl From<OpaqueMetadata> for Opaque

Available on crate feature canonical_extension_types only.

fn from(value: OpaqueMetadata) -> Self

Converts to this type from the input type.

impl PartialEq for Opaque

Available on crate feature canonical_extension_types only.

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

Available on crate feature canonical_extension_types only.