Module jlrs::wrappers::ptr[][src]

Expand description

Wrappers for builtin pointer types.

In this module you’ll find wrappers for all builtin pointer types. These are types like Module, DataType, and Array. These types often provide access to some specific functionality from the C API. For example, the Module wrapper provides access to the contents of Julia modules, and the Array wrapper access to the contents of n-dimensional Julia arrays.

The most common of these wrappers is Value, it represents some arbitrary data that Julia can use. Whenever you call a Julia function its arguments must be of this type, and a new one is returned. All pointer wrappers are valid Values.

One useful guarantee provided by wrappers is that they point to an existing value and are rooted. If a wrapper is returned that isn’t rooted, jlrs will return a Ref. Unlike a wrapper a ref can be undefined, and since it’s not rooted it’s not guaranteed to remain valid while it can be used. For more information about rooting please see the documentation of the memory module.

Modules

Wrappers for Array, create and access n-dimensional Julia arrays from Rust.

Call Julia functions.

Wrapper for CodeInstance.

Wrapper for DataType, which provides access to type properties.

Wrapper for Expr.

Wrapper for Function, the super type of all Julia functions.

Wrapper for Method.

Wrapper for MethodInstance.

Wrapper for MethodMatch.

Wrapper for MethodTable.

Wrapper for Module, which provides access to Julia’s modules and their contents.

Wrapper for SimpleVector.

Wrapper for String.

Wrapper for Symbol. Symbols represent identifiers like module and function names.

Wrapper for Task.

Wrapper for TypeName.

Wrapper for TypeVar.

Wrapper for TypeMapEntry.

Wrapper for TypeMapLevel.

Wrapper for Union.

Wrapper for UnionAll, A union of types over all values of a type parameter.

Wrapper for arbitrary Julia data.

Wrapper for WeakRef.

Structs

An unrooted reference to Julia data.

Traits

Methods shared by all builtin pointer wrappers.

Type Definitions

A reference to an Array

A reference to a CodeInstance

A reference to a DataType

A reference to an Expr

A reference to an Function

A reference to a MethodInstance

A reference to a MethodMatch

A reference to a Method

A reference to a MethodTable

A reference to a Module

A reference to a SimpleVector

A reference to a JuliaString

A reference to a Symbol

A reference to a Task

A reference to a TypeMapEntry

A reference to a TypeMapLevel

A reference to a TypeName

A reference to a TypeVar

A reference to an TypedArray

A reference to a UnionAll

A reference to a Union

A reference to a Value

A reference to a WeakRef