Struct Identity 

pub struct Identity {
    pub name: String,
    pub prefix: String,
    pub library: String,
    pub version: String,
    pub description: Option<String>,
    pub license: Option<String>,
    pub authors: Vec<String>,
    pub homepage: Option<String>,
    pub repository: Option<String>,
}

The resolved identity of the library being bound.

Every field is final: generators read names from here (and from the target’s own configuration overrides) and never invent their own.

Fields

name: String

Distribution name as published (may contain - or .).

prefix: String

C symbol prefix: a lower-snake C identifier that begins every exported symbol and every C type name ({prefix}_error, {prefix}_kv_get).

library: String

Native library base name: the producer is lib{library}.so, lib{library}.dylib, or {library}.dll.

version: String

Semantic version.

description: Option<String>

Short description, if declared.

license: Option<String>

License identifier, if declared.

authors: Vec<String>

Package authors.

homepage: Option<String>

Project homepage URL, if declared.

repository: Option<String>

Source repository URL, if declared.

Implementations

impl Identity

pub fn named(name: &str) -> Self

An identity with only a name: the prefix and library are the snake-case name and every metadata field is unset.

pub fn new(name: &str, package: &Package) -> Self

Resolve package (whose own name, if set, wins over name) into a complete identity. The prefix and library default to the snake-case form of the resolved name.

pub fn macro_prefix(&self) -> String

The uppercase prefix used for C preprocessor macros (KVSTORE_API, KVSTORE_ABI_VERSION).

pub fn snake_name(&self) -> String

The name as a lower-snake identifier (a Python import package, a Ruby require path, a Dart package). "my-kv.store" becomes "my_kv_store".

pub fn pascal_name(&self) -> String

The name as an UpperCamelCase identifier (a Swift module, a .NET namespace, a Ruby module). "my-kv.store" becomes "MyKvStore".

pub fn description_or_default(&self) -> String

The description, or a generated one when unset.

pub fn library_env_var(&self) -> String

The environment variable a generated loader consults for an explicit library path (KVSTORE_LIBRARY).

pub fn library_files(&self) -> (String, String, String)

Platform file names for the native library: (macOS, Linux, Windows).

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl Default for Identity

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Identity

impl Hash for Identity

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 Identity

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Identity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Identity