safeScope

Bindings in the safe scope are available to modules by default. They are all DeepFrozen.

Todo

Fix the module.name notation resulting from abuse of sphinx python support.

Todo

When Bool is fixed to reveal its interface, re-run mtDocStrings to document and, or, xor, not, butNot, pick, op__cmp.

Basic guards

class safeScope.Bool

The set of Boolean values: [true, false].asSet()

This guard is unretractable.

static coerce(_, _)

no docstring

static getDocstring()

no docstring

static getMethods()

no docstring

static supersetOf(_)

no docstring

class safeScope.Str

An ordered vector space.

As a guard, this object admits any value in the set of objects in the space. Comparison operators may be used on this object to create subguards which only admit a partition of the set.

static _printOn(_)

no docstring

static _uncall()

no docstring

static add(_)

no docstring

static coerce(_, _)

no docstring

static makeEmptyRegion()

no docstring

static makeRegion(_, _, _, _)

no docstring

static op__cmp(_)

no docstring

static subtract(_)

no docstring

_makeIterator()

no docstring

add(_)

no docstring

asList()

no docstring

asSet()

no docstring

contains(_)

no docstring

endsWith(_)

no docstring

get(_)

no docstring

getSpan()

no docstring

indexOf(_, _)

no docstring

isEmpty()

no docstring

join(_)

no docstring

lastIndexOf(_)

no docstring

multiply(_)

no docstring

op__cmp(_)

no docstring

quote()

no docstring

replace(_, _)

no docstring

size()

no docstring

slice(_)

no docstring

split(_, _)

no docstring

startsWith(_)

Whether this string has s as a prefix.

toLowerCase()

no docstring

toUpperCase()

no docstring

trim()

no docstring

with(_)

no docstring

class safeScope.Char

An ordered vector space.

As a guard, this object admits any value in the set of objects in the space. Comparison operators may be used on this object to create subguards which only admit a partition of the set.

static _printOn(_)

no docstring

static _uncall()

no docstring

static add(_)

no docstring

static coerce(_, _)

no docstring

static makeEmptyRegion()

no docstring

static makeRegion(_, _, _, _)

no docstring

static op__cmp(_)

no docstring

static subtract(_)

no docstring

add(_)

no docstring

asInteger()

no docstring

asString()

no docstring

getCategory()

no docstring

max(_)

no docstring

min(_)

no docstring

next()

no docstring

op__cmp(_)

no docstring

previous()

no docstring

quote()

no docstring

subtract(_)

no docstring

class safeScope.Double

An ordered vector space.

As a guard, this object admits any value in the set of objects in the space. Comparison operators may be used on this object to create subguards which only admit a partition of the set.

static _printOn(_)

no docstring

static _uncall()

no docstring

static add(_)

no docstring

static coerce(_, _)

no docstring

static makeEmptyRegion()

no docstring

static makeRegion(_, _, _, _)

no docstring

static op__cmp(_)

no docstring

static subtract(_)

no docstring

aboveZero()

no docstring

abs()

no docstring

add(_)

no docstring

approxDivide(_)

no docstring

atLeastZero()

no docstring

atMostZero()

no docstring

belowZero()

no docstring

cos()

no docstring

floor()

no docstring

floorDivide(_)

no docstring

isZero()

no docstring

log()

no docstring

multiply(_)

no docstring

negate()

no docstring

op__cmp(_)

no docstring

pow(_)

no docstring

sin()

no docstring

sqrt()

no docstring

subtract(_)

no docstring

tan()

no docstring

toBytes()

no docstring

class safeScope.Int

An ordered vector space.

As a guard, this object admits any value in the set of objects in the space. Comparison operators may be used on this object to create subguards which only admit a partition of the set.

static _printOn(_)

no docstring

static _uncall()

no docstring

static add(_)

no docstring

static coerce(_, _)

no docstring

static makeEmptyRegion()

no docstring

static makeRegion(_, _, _, _)

no docstring

static op__cmp(_)

no docstring

static subtract(_)

no docstring

aboveZero()

no docstring

abs()

no docstring

add(_)

no docstring

and(_)

no docstring

approxDivide(_)

no docstring

asDouble()

no docstring

atLeastZero()

no docstring

atMostZero()

no docstring

belowZero()

no docstring

bitLength()

no docstring

complement()

no docstring

floorDivide(_)

no docstring

isZero()

no docstring

max(_)

no docstring

min(_)

no docstring

mod(_)

no docstring

modPow(_, _)

no docstring

multiply(_)

no docstring

negate()

no docstring

next()

no docstring

op__cmp(_)

no docstring

or(_)

no docstring

pow(_)

no docstring

previous()

no docstring

shiftLeft(_)

no docstring

shiftRight(_)

no docstring

subtract(_)

no docstring

xor(_)

no docstring

class safeScope.Bytes

An ordered vector space.

As a guard, this object admits any value in the set of objects in the space. Comparison operators may be used on this object to create subguards which only admit a partition of the set.

static _printOn(_)

no docstring

static _uncall()

no docstring

static add(_)

no docstring

static coerce(_, _)

no docstring

static makeEmptyRegion()

no docstring

static makeRegion(_, _, _, _)

no docstring

static op__cmp(_)

no docstring

static subtract(_)

no docstring

_makeIterator()

no docstring

_uncall()

no docstring

add(_)

no docstring

asList()

no docstring

asSet()

no docstring

contains(_)

no docstring

get(_)

no docstring

indexOf(_)

no docstring

isEmpty()

no docstring

join(_)

no docstring

lastIndexOf(_)

no docstring

multiply(_)

no docstring

op__cmp(_)

no docstring

replace(_, _)

no docstring

size()

no docstring

slice(_)

no docstring

split(_, _)

no docstring

toLowerCase()

no docstring

toUpperCase()

no docstring

trim()

no docstring

with(_)

no docstring

class safeScope.List

A guard which admits lists.

Only immutable lists are admitted by this object. Mutable lists created with diverge/0 will not be admitted; freeze them first with snapshot/0.

static _printOn(_)

no docstring

static coerce(_, _)

no docstring

static extractGuard(_, _)

no docstring

static get(_)

no docstring

_makeIterator()

no docstring

_printOn(_)

no docstring

_uncall()

no docstring

add(_)

no docstring

asMap()

no docstring

asSet()

no docstring

contains(_)

no docstring

diverge()

no docstring

empty()

no docstring

get(_)

no docstring

indexOf(_)

no docstring

isEmpty()

no docstring

join(_)

no docstring

last()

no docstring

multiply(_)

no docstring

op__cmp(_)

no docstring

put(_, _)

no docstring

reverse()

no docstring

size()

no docstring

slice(_)

no docstring

snapshot()

no docstring

sort()

no docstring

startOf(_, _)

no docstring

with(_, _)

no docstring

class safeScope.Map

A guard which admits maps.

Only immutable maps are admitted by this object. Mutable maps created with diverge/0 will not be admitted; freeze them first with snapshot/0.

static _printOn(_)

no docstring

static coerce(_, _)

no docstring

static extractGuards(_, _)

no docstring

static get(_, _)

no docstring

_makeIterator()

no docstring

_printOn(_)

no docstring

_uncall()

no docstring

asSet()

no docstring

contains(_)

no docstring

diverge()

no docstring

empty()

no docstring

fetch(_, _)

no docstring

get(_)

no docstring

getKeys()

no docstring

getValues()

no docstring

isEmpty()

no docstring

or(_)

no docstring

reverse()

no docstring

size()

no docstring

slice(_)

no docstring

snapshot()

no docstring

sortKeys()

no docstring

sortValues()

no docstring

with(_, _)

no docstring

without(_)

no docstring

class safeScope.Set

A guard which admits sets.

Only immutable sets are admitted by this object. Mutable sets created with diverge/0 will not be admitted; freeze them first with snapshot/0.

static _printOn(_)

no docstring

static coerce(_, _)

no docstring

static extractGuard(_, _)

no docstring

static get(_)

no docstring

_makeIterator()

no docstring

_printOn(_)

no docstring

_uncall()

no docstring

and(_)

no docstring

asList()

no docstring

asSet()

no docstring

butNot(_)

no docstring

contains(_)

no docstring

diverge()

no docstring

empty()

no docstring

isEmpty()

no docstring

op__cmp(_)

no docstring

or(_)

no docstring

size()

no docstring

slice(_, _)

no docstring

snapshot()

no docstring

subtract(_)

no docstring

with(_)

no docstring

without(_)

no docstring

safeScope.Pair

A guard which admits immutable pairs.

Pairs are merely lists of size two.

safeScope._printOn(_)

no docstring

safeScope.coerce(_, _)

no docstring

safeScope.extractGuards(_, _)

no docstring

safeScope.get(_, _)

no docstring

class safeScope.FinalSlot

A guard which emits makers of FinalSlots.

static coerce(_, _)

no docstring

static extractGuard(_, _)

no docstring

static get(_)

no docstring

static getDocstring()

no docstring

static getGuard()

no docstring

static getMethods()

no docstring

static supersetOf(_)

no docstring

class safeScope.VarSlot

A guard which admits makers of VarSlots.

static coerce(_, _)

no docstring

static extractGuard(_, _)

no docstring

static get(_)

no docstring

static getDocstring()

no docstring

static getGuard()

no docstring

static getMethods()

no docstring

static supersetOf(_)

no docstring

Guard utilities

class safeScope.Any

A guard which admits the universal set.

This object specializes to a guard which admits the union of its subguards: Any[X, Y, Z] =~ X ∪ Y ∪ Z

This guard is unretractable.

static coerce(_, _)

no docstring

static extractGuards(_, _)

no docstring

static getMethods()

no docstring

static supersetOf(_)

no docstring

class safeScope.Void

The singleton set of null: [null].asSet()

This guard is unretractable.

static coerce(_, _)

no docstring

static getDocstring()

no docstring

static getMethods()

no docstring

static supersetOf(_)

no docstring

safeScope.Empty

An unretractable predicate guard.

This guard admits any object which passes its predicate.

safeScope._printOn(_)

no docstring

safeScope.coerce(_, _)

no docstring

safeScope.NullOk

A guard which admits null.

When specialized, this object returns a guard which admits its subguard as well as null.

safeScope.coerce(_, _)

no docstring

safeScope.extractGuard(_, _)

no docstring

safeScope.get(_)

no docstring

safeScope.Same

When specialized, this object yields a guard which only admits precisely the object used to specialize it.

In simpler terms, Same[x] will match only those objects o for which o == x.

safeScope.extractValue(_, _)

no docstring

safeScope.get(_)

no docstring

safeScope.Vow

A guard which admits promises and their entailments.

Vows admit the union of unfulfilled promises, fulfilled promises, broken promises, and Near values. The unifying concept is that of a partial future value to which messages will be sent but that is not Far.

When specialized, this guard returns a guard which ensures that promised prizes either conform to its subguard or are broken.

safeScope._printOn(_)

no docstring

safeScope.coerce(_, _)

no docstring

safeScope.extractGuard(_, _)

no docstring

safeScope.get(_)

no docstring

safeScope.SubrangeGuard

The maker of subrange guards.

When specialized with a guard, this object produces a auditor for those guards which admit proper subsets of that guard.

safeScope.get(_)

no docstring

safeScope._auditedBy

Whether an auditor has audited a specimen.

safeScope.run(_, _)

no docstring

Primitive values

safeScope.true

:Bool

safeScope.false

:Bool

safeScope.null

:Void

safeScope.NaN

:Double

safeScope.Infinity

:Double

Data Constructors

safeScope._makeInt

A maker of `Int`s.

This maker can handle radices from 2 to 36:

▲> _makeInt.withRadix(36)(“zxcvasdfqwer1234”) 7942433573816828193485776

safeScope.fromBytes(_, _)

no docstring

safeScope.run(_)

no docstring

safeScope.withRadix(_)

no docstring

safeScope._makeDouble

The maker of `Double`s.

safeScope.fromBytes(_, _)

no docstring

safeScope.run(_, _)

no docstring

safeScope._makeStr

The maker of `Str`s.

safeScope.fromChars(_)

no docstring

safeScope.fromStr(_, _)

no docstring

safeScope._makeString

The maker of `Str`s.

safeScope.fromChars(_)

no docstring

safeScope.fromStr(_, _)

no docstring

safeScope._makeBytes

The maker of Bytes.

safeScope.fromInts(_)

no docstring

safeScope.fromStr(_)

no docstring

safeScope._makeList

The maker of `List`s.

safeScope.fromIterable(_)

no docstring

safeScope._makeMap

Given a List[Pair], produce a Map.

safeScope.fromPairs(_)

no docstring

safeScope._makeOrderedSpace

The maker of ordered vector spaces.

This object implements several Monte operators, including those which provide ordered space syntax.

safeScope.op__thru(_, _)

no docstring

safeScope.op__till(_, _)

no docstring

safeScope.spaceOfGuard(_)

no docstring

safeScope.spaceOfValue(_)

no docstring

safeScope._makeTopSet
safeScope.run(_, _, _, _, _)

no docstring

safeScope._makeOrderedRegion

Make regions for sets of objects with total ordering.

safeScope.run(_, _, _)

no docstring

safeScope._makeSourceSpan

no docstring

safeScope.run(_, _, _, _, _, _)

no docstring

safeScope._makeFinalSlot

A maker of final slots.

safeScope.asType()

no docstring

safeScope.run(_, _, _)

no docstring

safeScope._makeVarSlot

A maker of var slots.

safeScope.asType()

no docstring

safeScope.run(_, _, _)

no docstring

safeScope.makeLazySlot

Make a slot that lazily binds its value.

safeScope.run(_)

no docstring

Tracing

safeScope.trace

Write a line to the trace log.

This object is a Typhon standard runtime traceln. It prints prefixed lines to stderr.

Call .exception(problem) to print a problem to stderr, including a formatted traceback.

safeScope.exception(_)

no docstring

safeScope.traceln

Write a line to the trace log.

This object is a Typhon standard runtime traceln. It prints prefixed lines to stderr.

Call .exception(problem) to print a problem to stderr, including a formatted traceback.

safeScope.exception(_)

no docstring

Brands

safeScope.makeBrandPair

Make a [sealer, unsealer] pair.

safeScope.run(_)

no docstring

Quasiparsers

``

A quasiparser of Unicode strings.

This object is the default quasiparser. It can interpolate any object into a string by pretty-printing it; in fact, that is one of this object’s primary uses.

When used as a pattern, this object performs basic text matching. Patterns always succeed, grabbing zero or more characters non-greedily until the next segment. When patterns are concatenated in the quasiliteral, only the rightmost pattern can match any characters; the other patterns to the left will all match the empty string.

safeScope.matchMaker(_)

no docstring

safeScope.patternHole(_)

no docstring

safeScope.valueHole(_)

no docstring

safeScope.valueMaker(_)

no docstring

b``

A quasiparser for Bytes.

This object behaves like simple__quasiParser; it takes some textual descriptions of bytes and returns a bytestring. It can interpolate objects which coerce to Bytes and Str.

As a pattern, this object performs slicing of bytestrings. Semantics mirror simple__quasiParser with respect to concatenated patterns and greediness.

safeScope.matchMaker(_)

no docstring

safeScope.patternHole(_)

no docstring

safeScope.valueHole(_)

no docstring

safeScope.valueMaker(_)

no docstring

m``

A quasiparser for the Monte programming language.

This object will parse any Monte expression and return an opaque value. In the near future, this object will instead return a translucent view into a Monte compiler and optimizer.

safeScope.fromStr(_)

no docstring

safeScope.getAstBuilder()

no docstring

safeScope.matchMaker(_)

no docstring

safeScope.patternHole(_)

no docstring

safeScope.valueHole(_)

no docstring

safeScope.valueMaker(_)

no docstring

mpatt``

A quasiparser for the Monte programming language’s patterns.

This object is like m``, but for patterns.

safeScope.fromStr(_)

no docstring

safeScope.getAstBuilder()

no docstring

safeScope.matchMaker(_)

no docstring

safeScope.patternHole(_)

no docstring

safeScope.valueHole(_)

no docstring

safeScope.valueMaker(_)

no docstring

Flow control

safeScope.M

Miscellaneous vat management and quoting services.

safeScope.call(_, _, _, _)

no docstring

safeScope.callWithMessage(_, _)

no docstring

safeScope.send(_, _, _, _)

no docstring

safeScope.sendOnly(_, _, _, _)

no docstring

safeScope.toQuote(_)

no docstring

safeScope.toString(_)

no docstring

safeScope.throw

no docstring

safeScope.eject(_, _)

no docstring

safeScope.run(_)

no docstring

safeScope._loop

Perform an iterative loop.

safeScope.run(_, _)

no docstring

safeScope._iterForever

Implementation of while-expression syntax.

safeScope._makeIterator()

no docstring

safeScope.next(_)

no docstring

Evaluation

safeScope.eval

Evaluate Monte source.

This object respects POLA and grants no privileges whatsoever to evaluated code. To grant a safe scope, pass safeScope.

safeScope.evalToPair(_, _)

no docstring

safeScope.run(_, _)

no docstring

safeScope.astEval

no docstring

safeScope.evalToPair(_, _)

no docstring

safeScope.run(_, _)

no docstring

Reference/object operations

safeScope.Ref

Ref management and utilities.

safeScope.broken(_)

no docstring

safeScope.fulfillment(_)

no docstring

safeScope.isBroken(_)

no docstring

safeScope.isDeepFrozen(_)

no docstring

safeScope.isEventual(_)

no docstring

safeScope.isFar(_)

no docstring

safeScope.isNear(_)

no docstring

safeScope.isResolved(_)

no docstring

safeScope.isSelfish(_)

no docstring

safeScope.isSelfless(_)

no docstring

safeScope.makeProxy(_, _, _)

no docstring

safeScope.optProblem(_)

no docstring

safeScope.promise()

no docstring

safeScope.state(_)

no docstring

safeScope.whenBroken(_, _)

no docstring

safeScope.whenBrokenOnly(_, _)

no docstring

safeScope.whenResolved(_, _)

no docstring

safeScope.whenResolvedOnly(_, _)

no docstring

safeScope.promiseAllFulfilled
safeScope.run(_)

no docstring

safeScope.DeepFrozen

Auditor and guard for transitive immutability.

safeScope.audit(_)

no docstring

safeScope.coerce(_, _)

no docstring

safeScope.supersetOf(_)

no docstring

safeScope.Selfless

A stamp for incomparable objects.

Selfless objects are generally not equal to any objects but themselves. They may choose to implement alternative comparison protocols such as Transparent.

safeScope.audit(_)

no docstring

safeScope.coerce(_, _)

no docstring

safeScope.passes(_)

no docstring

safeScope.Transparent

Objects that Transparent admits have reliable ._uncall() methods, in the sense that they correctly identify their maker and their entire state, and that invoking the maker with the given args will produce an object with the same state. Objects that are both Selfless and Transparent are compared for sameness by comparing their uncalls.

safeScope.coerce(_, _)

no docstring

safeScope.makeAuditorKit()

no docstring

safeScope.Near

A guard over references to near values.

This guard admits any near value, as well as any resolved reference to any near value.

This guard is unretractable.

safeScope.coerce(_, _)

no docstring

class safeScope.Binding

A guard which admits bindings.

static coerce(_, _)

no docstring

static getDocstring()

no docstring

static getMethods()

no docstring

static supersetOf(_)

no docstring

Abstract Syntax

safeScope.astBuilder
safeScope.AndExpr(_, _, _)

no docstring

safeScope.AssignExpr(_, _, _)

no docstring

safeScope.AugAssignExpr(_, _, _, _)

no docstring

safeScope.BinaryExpr(_, _, _, _)

no docstring

safeScope.BindPattern(_, _, _)

no docstring

safeScope.BindingExpr(_, _)

no docstring

safeScope.BindingPattern(_, _)

no docstring

safeScope.CatchExpr(_, _, _, _)

no docstring

safeScope.Catcher(_, _, _)

no docstring

safeScope.CoerceExpr(_, _, _)

no docstring

safeScope.CompareExpr(_, _, _, _)

no docstring

safeScope.CurryExpr(_, _, _, _)

no docstring

safeScope.DefExpr(_, _, _, _)

no docstring

safeScope.EscapeExpr(_, _, _, _, _)

no docstring

safeScope.ExitExpr(_, _, _)

no docstring

safeScope.FinalPattern(_, _, _)

no docstring

safeScope.FinallyExpr(_, _, _)

no docstring

safeScope.ForExpr(_, _, _, _, _, _, _)

no docstring

safeScope.ForwardExpr(_, _)

no docstring

safeScope.FunCallExpr(_, _, _, _)

no docstring

safeScope.FunSendExpr(_, _, _, _)

no docstring

safeScope.FunctionExpr(_, _, _, _)

no docstring

safeScope.FunctionInterfaceExpr(_, _, _, _, _, _, _)

no docstring

safeScope.FunctionScript(_, _, _, _, _)

no docstring

safeScope.GetExpr(_, _, _)

no docstring

safeScope.HideExpr(_, _)

no docstring

safeScope.IfExpr(_, _, _, _)

no docstring

safeScope.IgnorePattern(_, _)

no docstring

safeScope.InterfaceExpr(_, _, _, _, _, _, _)

no docstring

safeScope.ListComprehensionExpr(_, _, _, _, _, _)

no docstring

safeScope.ListExpr(_, _)

no docstring

safeScope.ListPattern(_, _, _)

no docstring

safeScope.LiteralExpr(_, _)

no docstring

safeScope.MapComprehensionExpr(_, _, _, _, _, _, _)

no docstring

safeScope.MapExpr(_, _)

no docstring

safeScope.MapExprAssoc(_, _, _)

no docstring

safeScope.MapExprExport(_, _)

no docstring

safeScope.MapPattern(_, _, _)

no docstring

safeScope.MapPatternAssoc(_, _, _, _)

no docstring

safeScope.MapPatternImport(_, _, _)

no docstring

safeScope.MatchBindExpr(_, _, _)

no docstring

safeScope.Matcher(_, _, _)

no docstring

safeScope.MessageDesc(_, _, _, _, _)

no docstring

safeScope.MetaContextExpr(_)

no docstring

safeScope.MetaStateExpr(_)

no docstring

safeScope.Method(_, _, _, _, _, _, _)

no docstring

safeScope.MethodCallExpr(_, _, _, _, _)

no docstring

safeScope.MismatchExpr(_, _, _)

no docstring

safeScope.Module(_, _, _, _)

no docstring

safeScope.NamedArg(_, _, _)

no docstring

safeScope.NamedArgExport(_, _)

no docstring

safeScope.NamedParam(_, _, _, _)

no docstring

safeScope.NamedParamImport(_, _, _)

no docstring

safeScope.NounExpr(_, _)

no docstring

safeScope.ObjectExpr(_, _, _, _, _, _)

no docstring

safeScope.OrExpr(_, _, _)

no docstring

safeScope.ParamDesc(_, _, _)

no docstring

safeScope.PatternHoleExpr(_, _)

no docstring

safeScope.PatternHolePattern(_, _)

no docstring

safeScope.PrefixExpr(_, _, _)

no docstring

safeScope.QuasiExprHole(_, _)

no docstring

safeScope.QuasiParserExpr(_, _, _)

no docstring

safeScope.QuasiParserPattern(_, _, _)

no docstring

safeScope.QuasiPatternHole(_, _)

no docstring

safeScope.QuasiText(_, _)

no docstring

safeScope.RangeExpr(_, _, _, _)

no docstring

safeScope.SameExpr(_, _, _, _)

no docstring

safeScope.SamePattern(_, _, _)

no docstring

safeScope.Script(_, _, _, _)

no docstring

safeScope.SendExpr(_, _, _, _, _)

no docstring

safeScope.SeqExpr(_, _)

no docstring

safeScope.SlotExpr(_, _)

no docstring

safeScope.SlotPattern(_, _, _)

no docstring

safeScope.SuchThatPattern(_, _, _)

no docstring

safeScope.SwitchExpr(_, _, _)

no docstring

safeScope.TempNounExpr(_, _)

no docstring

safeScope.To(_, _, _, _, _, _, _)

no docstring

safeScope.TryExpr(_, _, _, _)

no docstring

safeScope.ValueHoleExpr(_, _)

no docstring

safeScope.ValueHolePattern(_, _)

no docstring

safeScope.VarPattern(_, _, _)

no docstring

safeScope.VerbAssignExpr(_, _, _, _)

no docstring

safeScope.ViaPattern(_, _, _)

no docstring

safeScope.WhenExpr(_, _, _, _, _)

no docstring

safeScope.WhileExpr(_, _, _, _)

no docstring

safeScope.getAstGuard()

no docstring

safeScope.getExprGuard()

no docstring

safeScope.getNamePatternGuard()

no docstring

safeScope.getNounGuard()

no docstring

safeScope.getPatternGuard()

no docstring

Utilities for syntax expansions

safeScope._accumulateList

Implementation of list comprehension syntax.

safeScope.run(_, _)

no docstring

safeScope._accumulateMap

Implementation of map comprehension syntax.

safeScope.run(_, _)

no docstring

safeScope._bind

Resolve a forward declaration.

safeScope.run(_, _)

no docstring

safeScope._booleanFlow

Implementation of implicit breakage semantics in conditionally-defined names.

safeScope.broken()

no docstring

safeScope.failureList(_)

no docstring

safeScope._comparer

A comparison helper.

This object implements the various comparison operators.

safeScope.asBigAs(_, _)

no docstring

safeScope.geq(_, _)

no docstring

safeScope.greaterThan(_, _)

no docstring

safeScope.leq(_, _)

no docstring

safeScope.lessThan(_, _)

no docstring

safeScope._equalizer

A perceiver of identity.

This object can discern whether any two objects are distinct from each other.

safeScope.isSettled(_)

no docstring

safeScope.makeTraversalKey(_)

no docstring

safeScope.optSame(_, _)

no docstring

safeScope.sameEver(_, _)

no docstring

safeScope.sameYet(_, _)

no docstring

safeScope._makeVerbFacet

The operator obj.`method`.

safeScope.curryCall(_, _)

no docstring

safeScope.currySend(_, _)

no docstring

safeScope._mapEmpty

An unretractable predicate guard.

This guard admits any object which passes its predicate.

safeScope._printOn(_)

no docstring

safeScope.coerce(_, _)

no docstring

safeScope._mapExtract

Implementation of key pattern-matching syntax in map patterns.

safeScope.run(_)

no docstring

safeScope.withDefault(_, _)

no docstring

safeScope._matchSame
safeScope.different(_)

no docstring

safeScope.run(_)

no docstring

safeScope._quasiMatcher

Implementation of quasiliteral pattern syntax.

safeScope.run(_, _)

no docstring

safeScope._slotToBinding

Implementation of bind-pattern syntax for forward declarations.

safeScope.run(_, _)

no docstring

safeScope._splitList

Implementation of tail pattern-matching syntax in list patterns.

m`def [x] + xs := l`.expand() == m`def via (_splitList.run(1)) [x, xs] := l`

safeScope.run(_)

no docstring

safeScope._suchThat

The pattern patt ? (expr).

safeScope.run(_, _)

no docstring

safeScope._switchFailed

The implicit default matcher in a switch expression.

This object throws an exception.

safeScope._validateFor

Ensure that flag is true.

This object is a safeguard against malicious loop objects. A flag is set to true and closed over by a loop body; once the loop is finished, the flag is set to false and the loop cannot be reëntered.

safeScope.run(_)

no docstring

Interface constructors

safeScope._makeMessageDesc

Describe a message.

safeScope.run(_, _, _, _)

no docstring

safeScope._makeParamDesc

Describe a parameter.

safeScope.run(_, _)

no docstring

safeScope._makeProtocolDesc

Produce an interface.

safeScope.makePair(_, _, _, _, _)

no docstring

safeScope.run(_, _, _, _, _)

no docstring

Entrypoint Arguments

Todo

Fix the module.name notation resulting from abuse of sphinx python support.

Time

__entrypoint_io__.Timer

An unsafe nondeterministic clock.

This object provides a useful collection of time-related methods: * fromNow(delay :Double): Produce a promise which will fully resolve after at least delay seconds have elapsed in the runtime. The promise will resolve to a Double representing the precise amount of time elapsed, in seconds. * sendTimestamp(callable): Send a Double representing the runtime’s clock to callable.

There is extremely unsafe functionality as well: * unsafeNow(): The current system time.

Use with caution.

__entrypoint_io__.fromNow(_)

no docstring

__entrypoint_io__.sendTimestamp(_)

no docstring

__entrypoint_io__.unsafeNow()

no docstring

I/O

__entrypoint_io__.stdio

A producer of streamcaps for the ancient standard I/O bytestreams.

__entrypoint_io__.stderr()

no docstring

__entrypoint_io__.stdin()

no docstring

__entrypoint_io__.stdout()

no docstring

__entrypoint_io__.makeStdErr

no docstring

__entrypoint_io__.run()

no docstring

__entrypoint_io__.makeStdIn

no docstring

__entrypoint_io__.run()

no docstring

__entrypoint_io__.makeStdOut

no docstring

__entrypoint_io__.run()

no docstring

__entrypoint_io__.makeFileResource

Make a file Resource.

__entrypoint_io__.run(_)

no docstring

Networking

__entrypoint_io__.makeTCP4ClientEndpoint

Make a TCPv4 client endpoint.

__entrypoint_io__.run(_, _)

no docstring

__entrypoint_io__.makeTCP4ServerEndpoint

Make a TCPv4 server endpoint.

__entrypoint_io__.run(_)

no docstring

__entrypoint_io__.makeTCP6ClientEndpoint

Make a TCPv6 client endpoint.

__entrypoint_io__.run(_, _)

no docstring

__entrypoint_io__.makeTCP6ServerEndpoint

Make a TCPv4 server endpoint.

__entrypoint_io__.run(_)

no docstring

__entrypoint_io__.getAddrInfo

no docstring

__entrypoint_io__.run(_, _)

no docstring

Runtime

__entrypoint_io__.currentRuntime

The Typhon runtime.

This object is a platform-specific view into the configuration and performance of the current runtime in the current process.

This object is necessarily unsafe and nondeterministic.

__entrypoint_io__.getCrypt()

no docstring

__entrypoint_io__.getHeapStatistics()

no docstring

__entrypoint_io__.getReactorStatistics()

no docstring

__entrypoint_io__.unsealException

Unseal a specimen.

__entrypoint_io__.run(_, _)

no docstring

Processes and Vats

__entrypoint_io__.currentProcess

The current process on the local node.

__entrypoint_io__.getArguments()

no docstring

__entrypoint_io__.getEnvironment()

no docstring

__entrypoint_io__.getPID()

no docstring

__entrypoint_io__.interrupt()

no docstring

__entrypoint_io__.makeProcess

Create a subordinate process on the current node from the given executable, arguments, and environment.

=> stdin, => stdout, and => stderr control the same-named methods on the resulting process object, which will return a sink, source, and source respectively. If any of these named arguments are true, then the corresponding method on the process will return a live streamcap which is connected to the process; otherwise, the returned streamcap will be a no-op.

=> stdinFount, if not null, will be treated as a fount and it will be flowed to a drain representing stdin. => stdoutDrain and => stderrDrain are similar but should be drains which will have founts flowed to them.

__entrypoint_io__.run(_, _, _)

no docstring