Documentation

Documentation Sources Core Numbers AdditiveArithmetic.hylo AdditiveArithmetic zero()

Sources

Concurrency

Future.hylo

type Future

typealias Result
var frame
init(_:)
fun await()

type EscapingFuture

typealias Result
var frame
init(_:)
fun await()

type SpawnFrame

var base_frame
var f
var r
init(_:)
fun await()
static fun allocate(_:)

type SpawnFrameBase

let p1
let p2
let p3
let p4
let p5
let p6
let p7
let p8
let p9
let p10
init()

fun concore2full_spawn2(_:_:)
fun concore2full_await(_:)

Spawn.hylo
- fun spawn_(_:)
- fun escaping_spawn_(_:)

Core

String.hylo
- type String

Comparable.hylo

trait Comparable

fun <(_:)
fun >(_:)
fun <=(_:)
fun >=(_:)

subscript min(_:_:)
subscript max(_:_:)

Assert.hylo

fun fatal_error(_:file:line:)
fun precondition(_:_:file:line:)
fun log_failure_description(_:_:in:at:)
fun trap()
fun halt()

Bitcast.hylo

subscript unsafe_bitcast(_:)
fun unsafe_bitcast(consuming:)

PointerToMutable.hylo

type PointerToMutable

var base
init()
subscript unsafe()
init(adding_mutation_to:)
init(type_punning:)
init(bit_pattern:)
fun advance(by:)
static fun null()
fun unsafe_initialize_pointee(_:)

fun unsafe_initialize(copying_bytes_from:count:)

subscript mutable_pointer(to:)
fun initialize(_:to:)

Operators.hylo

operator infix<<
operator infix&<<
operator infix>>
operator infix&>>
operator infix*
operator infix&*
operator infix/
operator infix%
operator infix+
operator infix&+
operator infix-
operator infix&-
operator infix..<
operator infix...
operator infix??
operator infix==
operator infix!=
operator infix<
operator infix<=
operator infix>=
operator infix>
operator infix^
operator infix&
operator infix&&
operator infix|
operator infix||
operator infix<<=
operator infix&<<=
operator infix>>=
operator infix&>>=
operator infix*=
operator infix/=
operator infix%=
operator infix+=
operator infix-=
operator infix^=
operator infix&=
operator infix&&=
operator infix|=
operator infix||=
operator infix**
operator prefix+
operator prefix-
operator prefix~
operator prefix!
operator postfix!
operator postfix...

Hasher.hylo

type Hasher

var hash
init()
fun finalize()
fun combine(byte:)
fun combine(i32:)
fun combine(i64:)
fun unsafe_combine(bytes:)
fun combine(_:)

ForeignConvertible.hylo

trait ForeignConvertible

type ForeignRepresentation
init(foreign_value:)
fun foreign_value()

MemoryAddress.hylo
- typealias MemoryAddress

Range.hylo

type Range

var lower_bound
var upper_bound
init()
init(from:up_to:)
fun contains(_:)
fun contains(_:)

MemoryLayout.hylo

type MemoryLayout

static fun size()
static fun alignment()
static fun stride()

Bool.hylo

type Bool

var value
init()
init()
fun &&(_:)
fun ||(_:)
fun toggle()
fun !()
fun description()

Hashable.hylo
- trait Hashable
  - fun hash(into:)
Deinitializable.hylo
- trait Deinitializable
  - fun deinit()

Strideable.hylo

trait Strideable

type Stride: SignedNumeric, Comparable
fun offset(to:)
fun advance(by:)

PointerToBuffer.hylo

type PointerToBuffer

let start
let count
init()

Pointer.hylo

type Pointer

var base
init()
subscript unsafe()
init(bit_pattern:)
init(_:)
init(type_punning:)
init(type_punning:)
property raw
fun advance(by:)
static fun null()

subscript pointer(to:)
subscript pointer_to_bytes(of:)

Optional.hylo

typealias Optional
type None
- init()
- fun ==(_:)

Lifetime.hylo
- fun with_extended_lifetime(_:do:)
Copyable.hylo
- trait Copyable
  - fun copy()
Runtime.hylo
Linear.hylo
- trait Linear

CollectionOfOne.hylo

type CollectionOfOne

var contents
init(_:)

String

UTF8Array.hylo

type UTF8Array

typealias Header
let units
init()
init(taking_ownership_of:)
init()
init(unsafely_copying:reserving:)

static fun init_on_head(_:unsafely_copying:reserving:)

property nullterminated
fun is_empty()
fun capacity()
fun reserve_capacity(_:)
fun is_inline()
fun is_unowned()
fun requires_head_deallocation()
fun unsafe_heap_header()

Void.hylo
- typealias Void

MutableCollection.hylo

trait MutableCollection

subscript(_:)
fun swap_at(_:_:)

Numbers

Integers

BinaryInteger.hylo

trait BinaryInteger

init()
init(truncating_or_extending:)
fun instance_bit_width()
fun signum()
fun trailing_zeros()

fun quotient_and_remainder(dividing_by:)

fun words()
fun /(_:)
fun /=(_:)
fun %(_:)
fun %=(_:)
fun <(_:)
fun <=(_:)
fun >(_:)
fun >=(_:)
fun &(_:)
fun &=(_:)
fun |(_:)
fun |=(_:)
fun ^(_:)
fun ^=(_:)
fun <<(_:)
fun <<=(_:)
fun >>(_:)
fun >>=(_:)
static fun is_signed()

Int32.hylo

type Int32

var value
init()
init(bit_pattern:)
init(_:)
fun abs()
fun +()
fun ~()

Int8.hylo

type Int8

var value
init()
init(bit_pattern:)
init(_:)
fun abs()
fun +()
fun ~()

UInt32.hylo

type UInt32

var value
init()
init(bit_pattern:)
fun ~()

Int.hylo

type Int

var value
init()
init(bit_pattern:)
init(bit_pattern:)
fun abs()
fun round_up(nearest_multiple_of:)
fun round_up_nearest_power_two()
fun +()
fun ~()
fun &*(_:)

UInt.hylo

type UInt

var value
init()
init(bit_pattern:)
init(bit_pattern:)
fun round_up_nearest_power_two()
fun ~()

SignedInteger.hylo
- trait SignedInteger
  - fun successor()

UInt8.hylo

type UInt8

var value
init()
init(bit_pattern:)
fun ~()

UInt64.hylo

type UInt64

var value
init()
init(bit_pattern:)
fun ~()

FixedWidthInteger.hylo

trait FixedWidthInteger

fun matches(_:)
fun adding_reporting_overflow(_:)
fun subtracting_reporting_overflow(_:)
fun multiplied_reporting_overflow(by:)
fun divided_reporting_overflow(by:)

fun remainder_reporting_overflow(dividing_by:)

fun nonzero_bit_count()
fun leading_zeros()
fun &<<(_:)
fun &<<=(_:)
fun &>>(_:)
fun &>>=(_:)
static fun bit_width()
static fun max()
static fun min()

Int64.hylo

type Int64

var value
init()
init(bit_pattern:)
init(_:)
fun abs()
fun +()
fun ~()

Floats

Float64.hylo

type Float64

var value
init()
init()
fun +(_:)
fun +=(_:)
fun -(_:)
fun -=(_:)
fun *(_:)
fun *=(_:)
fun /(_:)
fun /=(_:)
fun %(_:)
fun %=(_:)
fun -()
fun +()
fun <(_:)
fun <=(_:)
fun >(_:)
fun >=(_:)
fun ==(_:)
fun !=(_:)
static fun pi()

Float32.hylo

type Float32

var value
init()
init()
init(_:)

AdditiveArithmetic.hylo

trait AdditiveArithmetic

fun +(_:)
fun +=(_:)
fun -(_:)
fun -=(_:)
static fun zero()

SignedNumeric.hylo
- trait SignedNumeric
  - fun -()
  - fun negate()
ExpressibleByFloatLiteral.hylo
- trait ExpressibleByFloatLiteral

Numeric.hylo

trait Numeric

type Magnitude: Comparable, Numeric
fun magnitude()
fun *(_:)
fun *=(_:)

ExpressibleByIntegerLiteral.hylo
- trait ExpressibleByIntegerLiteral

Regular.hylo
- trait SemiRegular
- trait Regular

Collection.hylo

trait Collection

type Element
type Position: Regular
fun start_position()
fun end_position()
fun position(after:)
subscript(_:)

Movable.hylo
- trait Movable
  - fun take_value(from:)
Equatable.hylo
- trait Equatable
  - fun ==(_:)
Iterator.hylo
- trait Iterator
  - type Element
  - fun next()

Pointers+DynamicAllocation.hylo

Heap.hylo

fun hylo_aligned_alloc(_:_:)
fun hylo_aligned_free(_:)

LibC.hylo

fun aligned_alloc(_:_:)
fun malloc(_:)
fun free(_:)
fun abort()
fun fdopen(_:_:)
fun fwrite(_:_:_:_:)
fun memcpy(_:_:_:)
fun memmove(_:_:_:)

BitArray.hylo

type BitArray

var bits
var bit_count
init()
fun count()
fun capacity()
fun append(_:)
subscript(_:)
fun set_value(_:for:)

Array.hylo

type Array

var storage
init()
init(count:initialized_with:)
fun deinit()
fun count()
fun is_empty()
fun capacity()
fun reserve_capacity(_:)
property contiguous_storage
fun with_mutable_contiguous_storage(_:)
fun append(_:)
fun insert(_:at:)
fun remove(at:)
fun remove_all(keeping_capacity:)
fun pop_last()
fun reverse()
subscript pointer_to_element(at:)

Print.hylo

fun print(_:terminator:)
fun print(_:radix:terminator:)
let stdout

DynamicBuffer.hylo

type DynamicBuffer

typealias BufferHeader
static fun payload_offset()
var storage
init()

init(capacity:initializing_header_with:)

fun first_element_address()
fun deinit()
fun capacity()
property header
fun buffer_header()

Function

zero()

Returns the value 0 represented in Self.

Source

static fun zero() -> Self