VolumeRateFormat class

Allows a VolumeRate to be formatted.

See UnitOfMeasurementFormat for general notes on the pattern syntax and VolumeRate for volume-specific notes.

final volumeRate = 42.liters().per(const Duration(minutes: 1));

// '2520L/hr'
final result1 = VolumeRateFormat().format(volumeRate);

// '2520 Liters per hour'
final result2 = VolumeRateFormat(pattern: "0.## U 'per' R").format(volumeRate);

// '14,950.84 ft³/wk'
final result3 = VolumeRateFormat(
  pattern: "###,##0.## u:ft³'/'r:wk",
  permissibleValueUnits: VolumeUnits.imperial,
  permissibleRateUnits: RateUnits.all,
).format(volumeRate);

See also:

Inheritance

Constructors

VolumeRateFormat({String pattern = "0.##${UnitOfMeasurementFormat.valueUnitSymbolFormatSpecifier}'/'${UnitOfMeasurementFormat.rateUnitSymbolFormatSpecifier}", Set<VolumeUnit> permissibleValueUnits = VolumeUnits.commonSi, Set<RateUnit> permissibleRateUnits = RateUnits.hourOrLess, String? locale})

Properties

hashCode → int
The hash code for this object.
no setterinherited
locale → String?
The locale to use when formatting values.
finalinherited
pattern → String
The pattern that indicates the desired output when formatting input values.
finalinherited
permissibleRateUnits → Set<RateUnit>
finalinherited
permissibleValueUnits → Set<VolumeUnit>
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

format(VolumeRate input) → String
Formats input according to the pattern and locale of this format.
inherited
getLargestUnit(VolumeRate input) → VolumeUnit
Determines the largest denomination of unit in input that has a value of at least 1.
override
getPatternSpecifierFor(VolumeUnit valueUnit) → String
Gets the pattern specifier for the given value unit.
inherited
getPermissibleRateUnits() → Set<RateUnit>
Gets a set of permissible RateUnit values.
inherited
getPermissibleValueUnits() → Set<VolumeUnit>
Gets a set of permissible TUnit values.
inherited
getUnitName(VolumeUnit unit, String locale) → String
Gets the a unit name in the given locale.
inherited
getUnitQuantity(VolumeRate input, VolumeUnit unit) → Rational
Determines how many units of unit the input contains, including any fractional portion.
override
getUnitSymbol(VolumeUnit unit, String locale) → String
Gets the a unit symbol in the given locale.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pluralizeValueUnits(String locale) → bool
Determines whether value units should be pluralized. Defaults to true.
inherited
scaleToRateUnit(VolumeRate input, RateUnit rateUnit) → VolumeRate
Scales input, which is assumed to be a rated unit of measurement, so that its rate is rateUnit.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited