Trait FunctionBased

pub trait FunctionBased:
    Debug
    + Clone
    + PartialEq
    + Send
    + Sync {
    type Header: Debug + Clone + PartialEq + Send + Sync;
    type Name: Debug + Clone + PartialEq + Send + Sync;
    type LeadingParameter: LeadingParameter + Serialize;
    type ParameterVisibility: ParameterVisibility + Serialize;
    type Body: ASTNode;

    // Required methods
    fn get_name(name: &Self::Name) -> Option<&str>;
    fn header_and_name_from_reader(
        reader: &mut impl TokenReader<TSXToken, TokenStart>,
        state: &mut ParsingState,
        options: &ParseOptions,
    ) -> ParseResult<(HeadingAndPosition<Self>, Self::Name)>;
    fn header_and_name_to_string_from_buffer<T: ToString>(
        buf: &mut T,
        header: &Self::Header,
        name: &Self::Name,
        options: &ToStringOptions,
        local: LocalToStringInformation,
    );
    fn visit_name<TData>(
        name: &Self::Name,
        visitors: &mut (impl VisitorReceiver<TData> + ?Sized),
        data: &mut TData,
        options: &VisitOptions,
        chain: &mut Annex<'_, Chain>,
    );
    fn visit_name_mut<TData>(
        name: &mut Self::Name,
        visitors: &mut (impl VisitorMutReceiver<TData> + ?Sized),
        data: &mut TData,
        options: &VisitOptions,
        chain: &mut Annex<'_, Chain>,
    );

    // Provided methods
    fn get_parameter_body_boundary_token() -> Option<TSXToken> { ... }
    fn has_body(_: &Self::Body) -> bool { ... }
    fn parameters_from_reader<T: ToString>(
        reader: &mut impl TokenReader<TSXToken, TokenStart>,
        state: &mut ParsingState,
        options: &ParseOptions,
    ) -> ParseResult<FunctionParameters<Self::LeadingParameter, Self::ParameterVisibility>> { ... }
    fn parameters_to_string_from_buffer<T: ToString>(
        buf: &mut T,
        parameters: &FunctionParameters<Self::LeadingParameter, Self::ParameterVisibility>,
        options: &ToStringOptions,
        local: LocalToStringInformation,
    ) { ... }
    fn parameter_body_boundary_token_to_string_from_buffer<T: ToString>(
        buf: &mut T,
        options: &ToStringOptions,
    ) { ... }
}

Specialization information for FunctionBase

Required Associated Types

type Header: Debug + Clone + PartialEq + Send + Sync

Includes a keyword and/or modifiers

type Name: Debug + Clone + PartialEq + Send + Sync

A name of the function

type LeadingParameter: LeadingParameter + Serialize

Cfg to make up for the fact serde_derive does not use syn_helpers

type ParameterVisibility: ParameterVisibility + Serialize

Cfg to make up for the fact serde_derive does not use syn_helpers

type Body: ASTNode

The body of the function

Required Methods

fn get_name(name: &Self::Name) -> Option<&str>

For debugging only

fn header_and_name_from_reader( reader: &mut impl TokenReader<TSXToken, TokenStart>, state: &mut ParsingState, options: &ParseOptions, ) -> ParseResult<(HeadingAndPosition<Self>, Self::Name)>

fn header_and_name_to_string_from_buffer<T: ToString>( buf: &mut T, header: &Self::Header, name: &Self::Name, options: &ToStringOptions, local: LocalToStringInformation, )

fn visit_name<TData>( name: &Self::Name, visitors: &mut (impl VisitorReceiver<TData> + ?Sized), data: &mut TData, options: &VisitOptions, chain: &mut Annex<'_, Chain>, )

fn visit_name_mut<TData>( name: &mut Self::Name, visitors: &mut (impl VisitorMutReceiver<TData> + ?Sized), data: &mut TData, options: &VisitOptions, chain: &mut Annex<'_, Chain>, )

Provided Methods

fn get_parameter_body_boundary_token() -> Option<TSXToken>

For [crate::ArrowFunction]

fn has_body(_: &Self::Body) -> bool

For overloading

fn parameters_from_reader<T: ToString>( reader: &mut impl TokenReader<TSXToken, TokenStart>, state: &mut ParsingState, options: &ParseOptions, ) -> ParseResult<FunctionParameters<Self::LeadingParameter, Self::ParameterVisibility>>

For [crate::ArrowFunction]

fn parameters_to_string_from_buffer<T: ToString>( buf: &mut T, parameters: &FunctionParameters<Self::LeadingParameter, Self::ParameterVisibility>, options: &ToStringOptions, local: LocalToStringInformation, )

For [crate::ArrowFunction]

fn parameter_body_boundary_token_to_string_from_buffer<T: ToString>( buf: &mut T, options: &ToStringOptions, )

For [crate::ArrowFunction]

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl FunctionBased for ClassConstructorBase

type Header = ()

type Name = ()

type Body = FunctionBody

type LeadingParameter = (Option<ThisParameter>, Option<SuperParameter>)

type ParameterVisibility = Option<Visibility>

impl FunctionBased for ClassFunctionBase

type Header = MethodHeader

type Name = WithComment<PropertyKey<PublicOrPrivate>>

type LeadingParameter = (Option<ThisParameter>, Option<SuperParameter>)

type ParameterVisibility = ()

type Body = FunctionBody

impl FunctionBased for ArrowFunctionBase

type Name = ()

type Header = bool

type Body = ExpressionOrBlock

type LeadingParameter = ()

type ParameterVisibility = ()

impl FunctionBased for ObjectLiteralMethodBase

type Name = WithComment<PropertyKey<AlwaysPublic>>

type Header = MethodHeader

type Body = Block

type LeadingParameter = Option<ThisParameter>

type ParameterVisibility = ()

impl<T: ExpressionOrStatementPosition> FunctionBased for GeneralFunctionBase<T>

type Name = T

type Header = FunctionHeader

type LeadingParameter = Option<ThisParameter>

type ParameterVisibility = ()

type Body = <T as ExpressionOrStatementPosition>::FunctionBody