Type Aliases
The following type aliases are available globally.
-
Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures.
Declaration
Swift
public typealias CowString = String
-
Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures.
Declaration
Swift
public typealias JsonValue = String
-
Public exported type identifying individual timers for
TimingDistributionMetricType
Declaration
Swift
public typealias GleanTimerId = TimerId
-
This implements the developer facing API for recording boolean metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The boolean API only exposes the
BooleanMetricType.set(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias BooleanMetricType = BooleanMetric
-
This implements the developer facing API for recording counter metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The counter API only exposes the
CounterMetricType.add(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias CounterMetricType = CounterMetric
-
This implements the developer facing API for recording memory distribution metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The memory distribution API only exposes the
MemoryDistributionMetricType.accumulate()
method.Declaration
Swift
public typealias MemoryDistributionMetricType = MemoryDistributionMetric
-
This implements the developer facing API for recording quantity metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The quantity API only exposes the
QuantityMetricType.set(_:)
method, which takes care of validating the input data and making sure that requirements are enforced.Declaration
Swift
public typealias QuantityMetricType = QuantityMetric
-
This implements the developer facing API for recording rate metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The rate API exposes the
RateMetricType.addToNumerator(_:)
andRateMetricType.addToDenominator(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias RateMetricType = RateMetric
-
This implements the developer facing API for recording a denominator of a rate metric, where the denominator is external. It is essentially a wrapper around
CounterMetricType
.Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The denominator API exposes the
DenominatorMetricType.add(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias DenominatorMetricType = DenominatorMetric
-
This implements the developer facing API for recording the numerator of a rate metric with an external denominator.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The numerator API exposes the
NumeratorMetrictype.addToNumerator(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias NumeratorMetricType = NumeratorMetric
-
This implements the developer facing API for recording string list metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The string list API only exposes the
StringListMetricType.add(_:)
andStringListMetricType.set(_:)
methods, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias StringListMetricType = StringListMetric
-
This implements the developer facing API for recording string metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The string API only exposes the
StringMetricType.set(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias StringMetricType = StringMetric
-
This implements the developer facing API for recording text metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The text API only exposes the
TextMetricType.set(_:)
method, which takes care of validating the input data and making sure that limits are enforced.Declaration
Swift
public typealias TextMetricType = TextMetric
-
This implements the developer facing API for recording timespan metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The timespan API only exposes the
TimespanMetricType.start()
,TimespanMetricType.stop()
andTimespanMetricType.cancel()
methods.Declaration
Swift
public typealias TimespanMetricType = TimespanMetric
-
This implements the developer facing API for recording timing distribution metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
The timing distribution API only exposes the
TimingDistributionMetricType.start()
,TimingDistributionMetricType.stopAndAccumulate(_:)
andTimingDistributionMetricType.cancel(_:)
methods.Declaration
Swift
public typealias TimingDistributionMetricType = TimingDistributionMetric