Skip to main content

AttributeChain

Struct AttributeChain 

Source
pub struct AttributeChain { /* private fields */ }
Expand description

A parsed Rust attribute expression made from a path root and zero or more dot calls.

Accepted roots are:

  • a path, such as RangeValidation::<_>.

Implementations§

Source§

impl AttributeChain

Source

pub fn parse_with_options( input: ParseStream<'_>, options: &ChainParseOptions, ) -> Result<Self>

Parse an AttributeChain from a ParseStream with custom options.

§Errors

Returns syn::Error when the token stream is not a supported path or dot-call chain, completion probes are disabled for probe syntax, or the configured completion marker cannot be emitted as a Rust identifier.

Source

pub fn parse_tokens_with_options( tokens: TokenStream, options: &ChainParseOptions, ) -> Result<Self>

Parse an AttributeChain from tokens with custom options.

§Errors

Returns syn::Error for the same syntax and option failures as Self::parse_with_options.

Source

pub fn root(&self) -> &Path

Source

pub fn root_path(&self) -> &Path

Examples found in repository?
examples/derive_field_attrs.rs (line 68)
55fn expand_field_attrs(field: &Field) -> syn::Result<Vec<TokenStream>> {
56    let field_ident = field
57        .ident
58        .as_ref()
59        .expect("named_fields only returns named struct fields");
60    let mut expansions = Vec::new();
61
62    for attr in &field.attrs {
63        if !attr.path().is_ident("attribute_dsl") {
64            continue;
65        }
66
67        let chain = attr.parse_args::<AttributeChain>()?;
68        let root = substitute_infer_in_path(chain.root_path(), &field.ty);
69
70        let calls = chain.calls().iter().map(|call| {
71            let method = call.method();
72            let turbofish = call.turbofish();
73            let args = call.args();
74            quote! { .#method #turbofish (#(#args),*) }
75        });
76
77        let completion = chain
78            .completion_marker()
79            .map(|marker| quote! { .#marker })
80            .unwrap_or_default();
81
82        expansions.push(quote! {
83            let _ = #root::builder_for(stringify!(#field_ident)) #(#calls)* #completion;
84        });
85    }
86
87    Ok(expansions)
88}
Source

pub fn calls(&self) -> &[ChainCall]

Examples found in repository?
examples/derive_field_attrs.rs (line 70)
55fn expand_field_attrs(field: &Field) -> syn::Result<Vec<TokenStream>> {
56    let field_ident = field
57        .ident
58        .as_ref()
59        .expect("named_fields only returns named struct fields");
60    let mut expansions = Vec::new();
61
62    for attr in &field.attrs {
63        if !attr.path().is_ident("attribute_dsl") {
64            continue;
65        }
66
67        let chain = attr.parse_args::<AttributeChain>()?;
68        let root = substitute_infer_in_path(chain.root_path(), &field.ty);
69
70        let calls = chain.calls().iter().map(|call| {
71            let method = call.method();
72            let turbofish = call.turbofish();
73            let args = call.args();
74            quote! { .#method #turbofish (#(#args),*) }
75        });
76
77        let completion = chain
78            .completion_marker()
79            .map(|marker| quote! { .#marker })
80            .unwrap_or_default();
81
82        expansions.push(quote! {
83            let _ = #root::builder_for(stringify!(#field_ident)) #(#calls)* #completion;
84        });
85    }
86
87    Ok(expansions)
88}
Source

pub fn completion(&self) -> &ChainCompletion

Source

pub fn has_completion_probe(&self) -> bool

Source

pub fn completion_marker(&self) -> Option<&Ident>

Examples found in repository?
examples/derive_field_attrs.rs (line 78)
55fn expand_field_attrs(field: &Field) -> syn::Result<Vec<TokenStream>> {
56    let field_ident = field
57        .ident
58        .as_ref()
59        .expect("named_fields only returns named struct fields");
60    let mut expansions = Vec::new();
61
62    for attr in &field.attrs {
63        if !attr.path().is_ident("attribute_dsl") {
64            continue;
65        }
66
67        let chain = attr.parse_args::<AttributeChain>()?;
68        let root = substitute_infer_in_path(chain.root_path(), &field.ty);
69
70        let calls = chain.calls().iter().map(|call| {
71            let method = call.method();
72            let turbofish = call.turbofish();
73            let args = call.args();
74            quote! { .#method #turbofish (#(#args),*) }
75        });
76
77        let completion = chain
78            .completion_marker()
79            .map(|marker| quote! { .#marker })
80            .unwrap_or_default();
81
82        expansions.push(quote! {
83            let _ = #root::builder_for(stringify!(#field_ident)) #(#calls)* #completion;
84        });
85    }
86
87    Ok(expansions)
88}
Source

pub fn span(&self) -> Span

Trait Implementations§

Source§

impl Clone for AttributeChain

Source§

fn clone(&self) -> AttributeChain

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AttributeChain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Parse for AttributeChain

Source§

fn parse(input: ParseStream<'_>) -> Result<Self>

Source§

impl ToTokens for AttributeChain

Source§

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream. Read more
Source§

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object. Read more
Source§

fn into_token_stream(self) -> TokenStream
where Self: Sized,

Convert self directly into a TokenStream object. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Spanned for T
where T: Spanned + ?Sized,

Source§

fn span(&self) -> Span

Returns a Span covering the complete contents of this syntax tree node, or Span::call_site() if this node is empty.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.