Struct darling_core::util::PathList

pub struct PathList(_);

A list of syn::Path instances. This type is used to extract a list of paths from an attribute.

Usage

An PathList field on a struct implementing FromMeta will turn #[builder(derive(serde::Debug, Clone))] into:

StructOptions {
    derive: PathList(vec![syn::Path::new("serde::Debug"), syn::Path::new("Clone")])
}

Implementations

impl PathList

pub fn new<T: Into<Path>>(vals: Vec<T>) -> Self

Create a new list.

pub fn to_strings(&self) -> Vec<String>

Create a new Vec containing the string representation of each path.

Methods from Deref<Target = Vec<Path>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

🔬 This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Clone for PathList

fn clone(&self) -> PathList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathList

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

Formats the value using the given formatter.

impl Default for PathList

fn default() -> PathList

Returns the “default value” for a type.

impl Deref for PathList

type Target = Vec<Path>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Vec<Path, Global>> for PathList

fn from(v: Vec<Path>) -> Self

Performs the conversion.

impl FromMeta for PathList

fn from_list(v: &[NestedMeta]) -> Result<Self>

Create an instance from a list of nested meta items.

fn from_nested_meta(item: &NestedMeta) -> Result<Self>

fn from_meta(item: &Meta) -> Result<Self>

Create an instance from a syn::Meta by dispatching to the format-appropriate trait function. This generally should not be overridden by implementers.

fn from_word() -> Result<Self>

Create an instance from the presence of the word in the attribute with no additional options specified.

fn from_value(value: &Lit) -> Result<Self>

Create an instance from a literal value of either foo = "bar" or foo("bar"). This dispatches to the appropriate method based on the type of literal encountered, and generally should not be overridden by implementers.

fn from_char(value: char) -> Result<Self>

Create an instance from a char literal in a value position.

fn from_string(value: &str) -> Result<Self>

Create an instance from a string literal in a value position.

fn from_bool(value: bool) -> Result<Self>

Create an instance from a bool literal in a value position.

impl PartialEq<PathList> for PathList

fn eq(&self, other: &PathList) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PathList) -> bool

This method tests for !=.

impl Eq for PathList

impl StructuralEq for PathList

impl StructuralPartialEq for PathList