Crate xlang_abi

A crate that provides abi-safe and stable wrappers of language and library constructs that don’t have fixed abi This provides shims for otherwise unusable constructs that can validly be passed accross ABI bounderies. All publically exposed types in this api have a stable layout and abi, that may only change on semver major versions Thus, it is valid to use these types accross versions

Interface

This crate relies on a number of special symbols, provided by an interface library, which is typically a cdylib (so that there is one copy at runtime). This interface is typically provided by the xlang_interface crate (which is linked by using the xlang crate), otherwise, it must be provided and linked separately.

The symbols that this crate expects the interface library to provide are considered unstable, but all start with either the xlang_ or XLANG_ prefix.

The symbols are publically available in the module that makes primary of them.

The current list is:

• alloc::xlang_allocate
• alloc::xlang_allocate_aligned
• alloc::xlang_deallocate
• alloc::xlang_deallocate_aligned
• alloc::xlang_on_allocation_failure
• hash::xlang_hash_bytes
• hash::XLANG_HASH_SEED

Modules

alloc

ABI Safe Interface for allocation. Also provides allocator functions that can be used accross modules (on windows, the system allocator cannot be safely used to do so)

boxed

Implementation of std::boxed::Box that uses the alloc::Allocator trait, and is ABI safe for all allocators

collection

Implementation of various collections that use the alloc::Allocator trait and that have Stable ABI

hash

Defines Hashers for xlang that perform consistent operations

io

Defines io traits and types that are ABI Safe and can be used with traits::DynRef (et. al)

ops

Try stuff

option

Defines an ABI safe equivalent for std::option::Option for all types.

pair

Defines a Pair type, which is an ABI safe two-tuple

prelude

prelude for xlang_abi

primitives

Primitive types defined by the OS (such as the size type and the pointer-sized type).

ptr

Defines pointer types and interfaces that are abi safe.

result

Defines an ABI safe equivalent to std::result::Result.

span

Defines ABI safe equivalents for &[T] and &mut [T]

string

Implementation of std::string::String that uses alloc::Allocator, and is ABI safe. Also defines an ABI safe equivalent for &str (but not &mut str)

traits

Defines an ABI safe interface for trait objects, by emulating the vtable and fat pointer

vec

Implementation of std::string::String that uses alloc::Allocator, and is ABI safe.

Macros

const_sv

Constructs a StringView in a constant context. This is equivalent to StringView::new(str), except it is valid in a const initializer

format

Version of std::format that returns a String

rustcall

A macro which allows definining functions, function pointer types, and extern blocks using the "rustcall" abi. This abi matches the ABI used by lcrust v0 for extern "Rust" functions, without #[track_caller] support. See The LCRust v0 ABI for details on the interface.

set

Creates a HashSet from given elements, discarding duplicates

span

Produces an immutable span over a static (promoted) array of constant exressions

try_

? operator for xlang_abi types

vec

Constructs a new vec containing the given elements.