RustQ.NativeDescriptor (rustq v0.6.0)

Resolved metadata for a RustQ.NativeRef.

A descriptor combines a native reference with parsed RustQ.Syn method metadata and, when available, a web source link derived from Cargo metadata.

Summary

expected_arg()

t()

Validates a descriptor's method argument/return shape.

Resolves a native method reference through a RustQ.Syn.Index.

Resolves a native method reference and validates its argument/return shape.

@type expected_arg() ::
  :self_ref
  | {:ref, String.t()}
  | {:impl_trait, String.t(), [String.t()]}
  | {:path, String.t()}
  | :any

@type expected_return() :: {:ref, String.t()} | {:path, String.t()} | :none | :any

@type t() :: %RustQ.NativeDescriptor{
  method: RustQ.Syn.Method.t(),
  ref: RustQ.NativeRef.t(),
  source_url: String.t() | nil
}

@spec assert_shape!(
  t(),
  keyword()
) :: t()

Validates a descriptor's method argument/return shape.

@spec resolve!(RustQ.Syn.Index.t(), RustQ.NativeRef.t()) :: t()

Resolves a native method reference through a RustQ.Syn.Index.

@spec resolve!(RustQ.Syn.Index.t(), RustQ.NativeRef.t(), keyword()) :: t()

Resolves a native method reference and validates its argument/return shape.