[−][src]Struct tremor_script::docs::FunctionDoc

pub struct FunctionDoc {
    pub signature: FunctionSignatureDoc,
    pub summary: Option<String>,
    pub description: String,
    pub examples: Option<String>,
}

Function documentation

Fields

signature: FunctionSignatureDoc

signature

summary: Option<String>

short description

description: String

full description for the function

examples: Option<String>

Example of usage

Trait Implementations

`impl Clone for FunctionDoc`[src]

`fn clone(&self) -> FunctionDoc`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for FunctionDoc`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<'de> Deserialize<'de> for FunctionDoc`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

`impl Display for FunctionDoc`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Serialize for FunctionDoc`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

Auto Trait Implementations

`impl RefUnwindSafe for FunctionDoc`

`impl Send for FunctionDoc`

`impl Sync for FunctionDoc`

`impl Unpin for FunctionDoc`

`impl UnwindSafe for FunctionDoc`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,` [src]

`impl<T> Downcast for T where T: Any,` [src]

`fn into_any(self: Box<T>) -> Box<dyn Any + 'static>`[src]

`fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>`[src]

`fn as_any(&self) -> &(dyn Any + 'static)`[src]

`fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)`[src]

`impl<T> DowncastSync for T where T: Send + Sync + Any,` [src]

`fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,`

`fn vzip(self) -> V`

[−][src]Struct tremor_script::docs::FunctionDoc

Fields

Trait Implementations

impl Clone for FunctionDoc[src]

fn clone(&self) -> FunctionDoc[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for FunctionDoc[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl<'de> Deserialize<'de> for FunctionDoc[src]

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>, [src]

impl Display for FunctionDoc[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl Serialize for FunctionDoc[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer, [src]

Auto Trait Implementations

impl RefUnwindSafe for FunctionDoc

impl Send for FunctionDoc

impl Sync for FunctionDoc

impl Unpin for FunctionDoc

impl UnwindSafe for FunctionDoc

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>, [src]

impl<T> Downcast for T where T: Any, [src]

fn into_any(self: Box<T>) -> Box<dyn Any + 'static>[src]

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>[src]

fn as_any(&self) -> &(dyn Any + 'static)[src]

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)[src]

impl<T> DowncastSync for T where T: Send + Sync + Any, [src]

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> ToString for T where T: Display + ?Sized, [src]

default fn to_string(&self) -> String[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

`impl Clone for FunctionDoc`[src]

`fn clone(&self) -> FunctionDoc`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for FunctionDoc`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<'de> Deserialize<'de> for FunctionDoc`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

`impl Display for FunctionDoc`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Serialize for FunctionDoc`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl RefUnwindSafe for FunctionDoc`

`impl Send for FunctionDoc`

`impl Sync for FunctionDoc`

`impl Unpin for FunctionDoc`

`impl UnwindSafe for FunctionDoc`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,` [src]

`impl<T> Downcast for T where T: Any,` [src]

`fn into_any(self: Box<T>) -> Box<dyn Any + 'static>`[src]

`fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>`[src]

`fn as_any(&self) -> &(dyn Any + 'static)`[src]

`fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)`[src]

`impl<T> DowncastSync for T where T: Send + Sync + Any,` [src]

`fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,`

`fn vzip(self) -> V`