Struct DocSection 

pub struct DocSection {
    pub include: bool,
    pub label: &'static str,
    pub description: Option<&'static str>,
}

Fields

include: bool

True to include this doc section in the public documentation, false otherwise

label: &'static str

A display label for the doc section. For example: “Math Expressions”

description: Option<&'static str>

An optional description for the doc section

Trait Implementations

impl Clone for DocSection

fn clone(&self) -> DocSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocSection

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

Formats the value using the given formatter.

impl Default for DocSection

fn default() -> Self

Returns a “default” Doc section.

This is suitable for user defined functions that do not appear in the DataFusion documentation.

impl Hash for DocSection

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 PartialEq for DocSection

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

impl StructuralPartialEq for DocSection