EgretDoc - unsafe

Location:system/unsafe

Module

Module documentation.

moduleunsafe

Classes

Classes and inheritance.

Functions

Free functions and class methods.

functionunsafe::ptr

Signaturefunc ptr(addr: integer) -> Ptr

func ptr(addr: integer) -> Ptr {
    return builtin.ptr(addr);
}

@briefProvides the system library operation `ptr`.

@detailsExecutes the `ptr` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

addrMemory address, socket address, or peer address used by the operation.

@returnReturns the operation result as `Ptr`.

functionunsafe::obj_ptr

Signaturefunc obj_ptr(x: AnyClass) -> Ptr

func obj_ptr(x: AnyClass) -> Ptr {
    return builtin.obj_ptr(x);
}

@briefProvides the system library operation `obj_ptr`.

@detailsExecutes the `obj_ptr` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

xInput value.

@returnReturns the operation result as `Ptr`.

functionunsafe::ptr_to_int

Signaturefunc ptr_to_int(p: Ptr) -> Int

func ptr_to_int(p: Ptr) -> Int {
    return builtin.ptr_to_int(p);
}

@briefProvides the system library operation `ptr_to_int`.

@detailsExecutes the `ptr_to_int` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int`.

functionunsafe::ptr_add

Signaturefunc ptr_add(p: Ptr, off_bytes: integer) -> Ptr

func ptr_add(p: Ptr, off_bytes: integer) -> Ptr {
    return builtin.ptr_add(p, off_bytes);
}

@briefProvides the system library operation `ptr_add`.

@detailsExecutes the `ptr_add` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
off_bytesSize or length value that limits how much data the operation processes.

@returnReturns the operation result as `Ptr`.

functionunsafe::load8

Signaturefunc load8(p: Ptr) -> Int8

func load8(p: Ptr) -> Int8 {
    return builtin.load8(p);
}

@briefProvides the system library operation `load8`.

@detailsExecutes the `load8` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int8`.

functionunsafe::load16

Signaturefunc load16(p: Ptr) -> Int16

func load16(p: Ptr) -> Int16 {
    return builtin.load16(p);
}

@briefProvides the system library operation `load16`.

@detailsExecutes the `load16` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int16`.

functionunsafe::load32

Signaturefunc load32(p: Ptr) -> Int32

func load32(p: Ptr) -> Int32 {
    return builtin.load32(p);
}

@briefProvides the system library operation `load32`.

@detailsExecutes the `load32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int32`.

functionunsafe::load64

Signaturefunc load64(p: Ptr) -> Int64

func load64(p: Ptr) -> Int64 {
    return builtin.load64(p);
}

@briefProvides the system library operation `load64`.

@detailsExecutes the `load64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int64`.

functionunsafe::store8

Signaturefunc store8(p: Ptr, v: integer) -> Void

func store8(p: Ptr, v: integer) -> Void {
    _ = builtin.store8(p, v);
    return;

@briefProvides the system library operation `store8`.

@detailsExecutes the `store8` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::store16

Signaturefunc store16(p: Ptr, v: integer) -> Void

func store16(p: Ptr, v: integer) -> Void {
    _ = builtin.store16(p, v);
    return;

@briefProvides the system library operation `store16`.

@detailsExecutes the `store16` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::store32

Signaturefunc store32(p: Ptr, v: integer) -> Void

func store32(p: Ptr, v: integer) -> Void {
    _ = builtin.store32(p, v);
    return;

@briefProvides the system library operation `store32`.

@detailsExecutes the `store32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::store64

Signaturefunc store64(p: Ptr, v: integer) -> Void

func store64(p: Ptr, v: integer) -> Void {
    _ = builtin.store64(p, v);
    return;

@briefProvides the system library operation `store64`.

@detailsExecutes the `store64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::volatile_load8

Signaturefunc volatile_load8(p: Ptr) -> Int8

func volatile_load8(p: Ptr) -> Int8 {
    return builtin.volatile_load8(p);
}

@briefProvides the system library operation `volatile_load8`.

@detailsExecutes the `volatile_load8` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int8`.

functionunsafe::volatile_load16

Signaturefunc volatile_load16(p: Ptr) -> Int16

func volatile_load16(p: Ptr) -> Int16 {
    return builtin.volatile_load16(p);
}

@briefProvides the system library operation `volatile_load16`.

@detailsExecutes the `volatile_load16` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int16`.

functionunsafe::volatile_load32

Signaturefunc volatile_load32(p: Ptr) -> Int32

func volatile_load32(p: Ptr) -> Int32 {
    return builtin.volatile_load32(p);
}

@briefProvides the system library operation `volatile_load32`.

@detailsExecutes the `volatile_load32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int32`.

functionunsafe::volatile_load64

Signaturefunc volatile_load64(p: Ptr) -> Int64

func volatile_load64(p: Ptr) -> Int64 {
    return builtin.volatile_load64(p);
}

@briefProvides the system library operation `volatile_load64`.

@detailsExecutes the `volatile_load64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.

@returnReturns the operation result as `Int64`.

functionunsafe::volatile_store8

Signaturefunc volatile_store8(p: Ptr, v: integer) -> Void

func volatile_store8(p: Ptr, v: integer) -> Void {
    _ = builtin.volatile_store8(p, v);
    return;

@briefProvides the system library operation `volatile_store8`.

@detailsExecutes the `volatile_store8` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::volatile_store16

Signaturefunc volatile_store16(p: Ptr, v: integer) -> Void

func volatile_store16(p: Ptr, v: integer) -> Void {
    _ = builtin.volatile_store16(p, v);
    return;

@briefProvides the system library operation `volatile_store16`.

@detailsExecutes the `volatile_store16` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::volatile_store32

Signaturefunc volatile_store32(p: Ptr, v: integer) -> Void

func volatile_store32(p: Ptr, v: integer) -> Void {
    _ = builtin.volatile_store32(p, v);
    return;

@briefProvides the system library operation `volatile_store32`.

@detailsExecutes the `volatile_store32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

functionunsafe::volatile_store64

Signaturefunc volatile_store64(p: Ptr, v: integer) -> Void

func volatile_store64(p: Ptr, v: integer) -> Void {
    _ = builtin.volatile_store64(p, v);
    return;

@briefProvides the system library operation `volatile_store64`.

@detailsExecutes the `volatile_store64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.

@param

pNative pointer address passed to the runtime binding.
vValue argument consumed, stored, encoded, compared, or forwarded by this API.

@returnVoid

Variables

Class fields (var).