scala3-compiler-bootstrapped
DocsAPI
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.dotc/dotty.tools.dotc.cc/CaptureSet

CaptureSet

dotty.tools.dotc.cc.CaptureSet
See theCaptureSet companion class
object CaptureSet

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
CaptureSet.type

Members list

Type members

Classlikes

final class BiMapped extends DerivedVar

A mapping where the type map is required to be a bijection. Parameters as in Mapped.

A mapping where the type map is required to be a bijection. Parameters as in Mapped.

Attributes

Supertypes
class DerivedVar
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
class CSImpliedByCapability(parent: Type)(using ctx: Context) extends Const

Attributes

Supertypes
class Const
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
class Const extends CaptureSet

The subclass of constant capture sets with given elements elems

The subclass of constant capture sets with given elements elems

Attributes

Supertypes
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Known subtypes
object Fluid
abstract class DerivedVar(owner: Symbol, initialElems: Refs)(using ctx: Context) extends Var

A variable that is derived from some other variable via a map or filter.

A variable that is derived from some other variable via a map or filter.

Attributes

Supertypes
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
Known subtypes
class BiMapped
class Filtered
class Diff
class Diff(source: Var, other: Const)(using x$3: Context) extends Filtered

A variable with elements given at any time as { x <- source.elems | !other.accountsFor(x) }

A variable with elements given at any time as { x <- source.elems | !other.accountsFor(x) }

Attributes

Supertypes
class Filtered
class DerivedVar
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
case class EmptyWithProvenance(ref: Capability, mapped: CaptureSet) extends Const

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Const
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
case class ExistentialSubsumesFailure(ex: ResultCap, other: Capability) extends ErrorNote

A value of this class is produced and added as a note to ccState when a subsumes check decides that an existential variable ex cannot be instantiated to the other capability other.

A value of this class is produced and added as a note to ccState when a subsumes check decides that an existential variable ex cannot be instantiated to the other capability other.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ErrorNote
class Object
trait Matchable
class Any
Show all
class Filtered extends DerivedVar

A variable with elements given at any time as { x <- source.elems | p(x) }

A variable with elements given at any time as { x <- source.elems | p(x) }

Attributes

Supertypes
class DerivedVar
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
Known subtypes
class Diff
object Fluid extends Const

A special capture set that gets added to the types of symbols that were not themselves capture checked, in order to admit arbitrary corresponding capture sets in subcapturing comparisons. Similar to platform types for explicit nulls, this provides more lenient checking against compilation units that were not yet compiled with capture checking on.

A special capture set that gets added to the types of symbols that were not themselves capture checked, in order to admit arbitrary corresponding capture sets in subcapturing comparisons. Similar to platform types for explicit nulls, this provides more lenient checking against compilation units that were not yet compiled with capture checking on.

Attributes

Supertypes
class Const
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
Self type
Fluid.type
class HiddenSet(initialOwner: Symbol, val owningCap: FreshCap)(using ictx: Context) extends Var

A capture set variable used to record the references hidden by a Fresh instance, The elems and deps members are repurposed as follows: elems: Set of hidden references deps : Set of hidden sets for which the Fresh instance owning this set is a hidden element. Hidden sets may become aliases of other hidden sets, which means that reads and writes of elems go to the alias. If H is an alias of R.hidden for some Fresh instance R then: H.elems == {R} H.deps = {R.hidden} This encoding was chosen because it relies only on the elems and deps fields which are already subject through snapshotting and rollbacks in VarState. It's advantageous if we don't need to deal with other pieces of state there.

A capture set variable used to record the references hidden by a Fresh instance, The elems and deps members are repurposed as follows: elems: Set of hidden references deps : Set of hidden sets for which the Fresh instance owning this set is a hidden element. Hidden sets may become aliases of other hidden sets, which means that reads and writes of elems go to the alias. If H is an alias of R.hidden for some Fresh instance R then: H.elems == {R} H.deps = {R.hidden} This encoding was chosen because it relies only on the elems and deps fields which are already subject through snapshotting and rollbacks in VarState. It's advantageous if we don't need to deal with other pieces of state there.

Attributes

Supertypes
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
trait IdentityCaptRefMap extends TypeMap

A TypeMap that is the identity on capabilities

A TypeMap that is the identity on capabilities

Attributes

Supertypes
class TypeMap
trait Type => Type
class Object
trait Matchable
class Any
Show all
Known subtypes
class SimplifyMap
case class IncludeFailure(cs: CaptureSet, elem: Capability, levelError: Boolean = ...) extends ErrorNote, Showable

Failure indicating that elem cannot be included in cs

Failure indicating that elem cannot be included in cs

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Showable
trait ErrorNote
class Object
trait Matchable
class Any
Show all
class Intersection(cs1: CaptureSet, cs2: CaptureSet)(using x$3: Context) extends Var

Attributes

Supertypes
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
case class MutAdaptFailure(cs: CaptureSet, lo: Type = ..., hi: Type = ...) extends ErrorNote

Failure indicating that a read-only capture set of a mutable type cannot be widened to an exclusive set.

Failure indicating that a read-only capture set of a mutable type cannot be widened to an exclusive set.

Value parameters

cs

the exclusive set in question

hi

the upper type of the orginal type comparison, or NoType if not known

lo

the lower type of the orginal type comparison, or NoType if not known

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ErrorNote
class Object
trait Matchable
class Any
Show all
enum Mutability

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ProperVar(val owner: Symbol, initialElems: Refs = ..., nestedOK: Boolean = ..., isRefining: Boolean)(using ictx: Context) extends Var

Variables created in types of inferred type trees

Variables created in types of inferred type trees

Attributes

Supertypes
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
class Union(cs1: CaptureSet, cs2: CaptureSet)(using x$3: Context) extends Var

Attributes

Supertypes
class Var
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Show all
class Var(initialOwner: Symbol = ..., initialElems: Refs = ..., nestedOK: Boolean = ...)(using ictx: Context) extends CaptureSet

The subclass of captureset variables with given initial elements

The subclass of captureset variables with given initial elements

Value parameters

initialElems

the initial elements

initialOwner

the initial owner. This is the real owner, except that it can be change in HiddenSets. Used for level checking if different from NoSymbol.

nestedOK

relevant only if owner != NoSymbol. If true the set accepts elements that are directly owned by owner.

Attributes

Supertypes
class CaptureSet
trait Showable
class Object
trait Matchable
class Any
Known subtypes
class DerivedVar
class BiMapped
class Filtered
class Diff
class HiddenSet
class ProperVar
Show all
class VarState

A VarState serves as a snapshot mechanism that can undo additions of elements or super sets if an operation fails

A VarState serves as a snapshot mechanism that can undo additions of elements or super sets if an operation fails

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Closed
class Separating
object CCState.this.HardSeparate
object CCState.this.Separate
trait Stateless
class Unrecorded
object CCState.this.Unrecorded
Show all
object VarState

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
VarState.type

Types

Value members

Concrete methods

def apply(elems: Capability*)(using Context): Const
def apply(elems: Refs)(using Context): Const
def fresh(owner: Symbol, prefix: Type, origin: Origin)(using Context): Const
def fresh(origin: Origin)(using Context): Const
def mapRefs(xs: Refs, f: Capability => CaptureSet)(using Context): CaptureSet

Apply f to each element in xs, and join result sets with ++

Apply f to each element in xs, and join result sets with ++

Attributes

def mapRefs(xs: Refs, tm: TypeMap, variance: Int)(using Context): CaptureSet

Apply extrapolated tm to each element in xs, and join result sets with ++

Apply extrapolated tm to each element in xs, and join result sets with ++

Attributes

final def mappedSet(r: Capability, tm: TypeMap, variance: Int)(using Context): CaptureSet

Extrapolate tm(r) according to variance. Let r1 be the result of tm(r).

Extrapolate tm(r) according to variance. Let r1 be the result of tm(r).

  • If r1 is a tracked capability, return {r1}
  • If r1 has an empty capture set, return {}
  • Otherwise,
    • if the variance is covariant, return r1's capture set
    • if the variance is contravariant, return {}
    • Otherwise assertion failure

Attributes

def ofInfo(c: Capability)(using Context): CaptureSet

The capture set of the type underlying the capability c

The capture set of the type underlying the capability c

Attributes

def ofType(tp: Type, followResult: Boolean)(using Context): CaptureSet

Capture set of a type

Capture set of a type

Value parameters

followResult

If true, also include capture sets of function results.

Attributes

def ofTypeDeeply(tp: Type, includeTypevars: Boolean = ..., includeBoxed: Boolean = ...)(using Context): CaptureSet

The deep capture set of a type is the union of all covariant occurrences of capture sets. Nested existential sets are approximated with cap.

The deep capture set of a type is the union of all covariant occurrences of capture sets. Nested existential sets are approximated with cap.

Attributes

def shared(using Context): Const

The shared capture set {cap.rd}

The shared capture set {cap.rd}

Attributes

def subCapturesRange(arg1: TypeBounds, arg2: Type)(using Context): Boolean

Return true iff

Return true iff

  • arg1 is a TypeBounds >: CL T <: CH T of two capturing types with equal parents.
  • arg2 is a capturing type CA U
  • CH <: CA <: CL In other words, we can unify CL, CH and CA.

Attributes

def universal(using Context): Const

The universal capture set {cap}

The universal capture set {cap}

Attributes

def varState(using state: VarState): VarState

The current VarState, as passed by the implicit context

The current VarState, as passed by the implicit context

Attributes

def withCaptureSetsExplained[T](op: Context ?=> T)(using ctx: Context): T

Perform op. Under -Ycc-debug, collect and print info about all variables reachable via (_.deps)* from the variables that were shown in op.

Perform op. Under -Ycc-debug, collect and print info about all variables reachable via (_.deps)* from the variables that were shown in op.

Attributes

Concrete fields

inline val debugTarget: 1745
inline val debugVars: false

If true emit info when var with id debugTarget is created or gets a new element

If true emit info when var with id debugTarget is created or gets a new element

Attributes

val empty: Const

The empty capture set {}

The empty capture set {}

Attributes

Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL