Struct PathType

#[non_exhaustive]
pub struct PathType {
    pub path: Path,
    pub lifetimes: Vec<Lifetime>,
}

A named type that is just a path, e.g. std::borrow::Cow<'a, T>.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: Path

lifetimes: Vec<Lifetime>

Implementations

impl PathType

pub fn to_syn(&self) -> TypePath

pub fn new(path: Path) -> Self

pub fn extract_self_type(strct: &ItemStruct) -> Self

Get the Self type from a struct declaration.

Consider the following struct declaration:

struct RefList<'a> {
    data: &'a i32,
    next: Option<Box<Self>>,
}

When determining what type Self is in the next field, we would have to call this method on the syn::ItemStruct that represents this struct declaration. This method would then return a PathType representing RefList<'a>, so we know that’s what Self should refer to.

The reason this function exists though is so when we convert the fields’ types to PathTypes, we don’t panic. We don’t actually need to write the struct’s field types expanded in the macro, so this function is more for correctness,

pub fn resolve_with_path<'a>( &self, in_path: &Path, env: &'a Env, ) -> (Path, &'a CustomType)

If this is a TypeName::Named, grab the CustomType it points to from the env, which contains all CustomTypes across all FFI modules.

Also returns the path the CustomType is in (useful for resolving fields)

pub fn resolve<'a>(&self, in_path: &Path, env: &'a Env) -> &'a CustomType

If this is a TypeName::Named, grab the CustomType it points to from the env, which contains all CustomTypes across all FFI modules.

If you need to resolve struct fields later, call Self::resolve_with_path() instead to get the path to resolve the fields in.

Trait Implementations

impl Clone for PathType

fn clone(&self) -> PathType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PathType

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

Formats the value using the given formatter.

impl From<&TypePath> for PathType

fn from(other: &TypePath) -> Self

Converts to this type from the input type.

impl From<Path> for PathType

fn from(other: Path) -> Self

Converts to this type from the input type.

impl Hash for PathType

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 PathType

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PathType

impl StructuralPartialEq for PathType