Struct Attribute

pub struct Attribute { /* private fields */ }

Functions, function parameters, and return types can have Attributes to indicate how they should be treated by optimizations and code generation.

Implementations

impl Attribute

pub unsafe fn new(attribute: LLVMAttributeRef) -> Self

Creates a new Attribute from a raw pointer.

pub fn as_mut_ptr(&self) -> LLVMAttributeRef

Acquires the underlying raw pointer belonging to this Attribute type.

pub fn is_enum(self) -> bool

Determines whether or not an Attribute is an enum. This method will likely be removed in the future in favor of Attributes being generically defined.

Example

use inkwell::context::Context;

let context = Context::create();
let enum_attribute = context.create_enum_attribute(0, 10);

assert!(enum_attribute.is_enum());

pub fn is_string(self) -> bool

Determines whether or not an Attribute is a string. This method will likely be removed in the future in favor of Attributes being generically defined.

Example

use inkwell::context::Context;

let context = Context::create();
let string_attribute = context.create_string_attribute("my_key_123", "my_val");

assert!(string_attribute.is_string());

pub fn is_type(self) -> bool

Available on crate features llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 or llvm18-0 only.

Determines whether or not an Attribute is a type attribute. This method will likely be removed in the future in favor of Attributes being generically defined.

Example

use inkwell::context::Context;
use inkwell::attributes::Attribute;

let context = Context::create();
let kind_id = Attribute::get_named_enum_kind_id("sret");
let type_attribute = context.create_type_attribute(
    kind_id,
    context.i32_type().into(),
);

assert!(type_attribute.is_type());

pub fn get_named_enum_kind_id(name: &str) -> u32

Gets the enum kind id associated with a builtin name.

Example

use inkwell::attributes::Attribute;

// This kind id doesn't exist:
assert_eq!(Attribute::get_named_enum_kind_id("foobar"), 0);

// These are real kind ids:
assert_eq!(Attribute::get_named_enum_kind_id("align"), 1);
assert_eq!(Attribute::get_named_enum_kind_id("builtin"), 5);

pub fn get_enum_kind_id(self) -> u32

Available on crate features llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 or llvm18-0 only.

Gets the kind id associated with an enum Attribute.

Example

use inkwell::context::Context;

let context = Context::create();
let enum_attribute = context.create_enum_attribute(0, 10);

assert_eq!(enum_attribute.get_enum_kind_id(), 0);

This function also works for type Attributes.

use inkwell::context::Context;
use inkwell::attributes::Attribute;
use inkwell::types::AnyType;

let context = Context::create();
let kind_id = Attribute::get_named_enum_kind_id("sret");
let any_type = context.i32_type().as_any_type_enum();
let type_attribute = context.create_type_attribute(
    kind_id,
    any_type,
);

assert_eq!(type_attribute.get_enum_kind_id(), kind_id);

pub fn get_last_enum_kind_id() -> u32

Gets the last enum kind id associated with builtin names.

Example

use inkwell::attributes::Attribute;

assert_eq!(Attribute::get_last_enum_kind_id(), 56);

pub fn get_enum_value(self) -> u64

Gets the value associated with an enum Attribute.

Example

use inkwell::context::Context;

let context = Context::create();
let enum_attribute = context.create_enum_attribute(0, 10);

assert_eq!(enum_attribute.get_enum_value(), 10);

pub fn get_string_kind_id(&self) -> &CStr

Gets the string kind id associated with a string attribute.

Example

use inkwell::context::Context;

let context = Context::create();
let string_attribute = context.create_string_attribute("my_key", "my_val");

assert_eq!(string_attribute.get_string_kind_id().to_str(), Ok("my_key"));

pub fn get_string_value(&self) -> &CStr

Gets the string value associated with a string attribute.

Example

use inkwell::context::Context;

let context = Context::create();
let string_attribute = context.create_string_attribute("my_key", "my_val");

assert_eq!(string_attribute.get_string_value().to_str(), Ok("my_val"));

pub fn get_type_value(&self) -> AnyTypeEnum<'_>

Available on crate features llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 or llvm18-0 only.

Gets the type associated with a type attribute.

Example

use inkwell::context::Context;
use inkwell::attributes::Attribute;
use inkwell::types::AnyType;

let context = Context::create();
let kind_id = Attribute::get_named_enum_kind_id("sret");
let any_type = context.i32_type().as_any_type_enum();
let type_attribute = context.create_type_attribute(
    kind_id,
    any_type,
);

assert!(type_attribute.is_type());
assert_eq!(type_attribute.get_type_value(), any_type);
assert_ne!(type_attribute.get_type_value(), context.i64_type().as_any_type_enum());

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl PartialEq for Attribute

fn eq(&self, other: &Self) -> 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 Copy for Attribute

impl Eq for Attribute