init(style:allowedUnits:spellsOutZero:includesActualByteCount:locale:)

Declaration

init(style: ByteCountFormatStyle.Style = .file, allowedUnits: ByteCountFormatStyle.Units = .all, spellsOutZero: Bool = true, includesActualByteCount: Bool = false, locale: Locale = .autoupdatingCurrent)

Parameters

• style:

  The style of byte count to express, such as memory or file system storage.

• allowedUnits:

  The units the format style can use to express the byte count.

• spellsOutZero:

  A Boolean value that indicates whether the format style should spell out zero-byte values as text, like Zero kB.

• includesActualByteCount:

  A Boolean value that indicates whether the format style should include the exact byte count, in addition to expressing it in terms of units. For example, 1 kB (1,024 bytes).

• locale:

  The locale to use to format the numeric part of the byte count.

Discussion

In situations that can infer the ByteCountFormatStyle type, you can call byteCount(style:allowedUnits:spellsOutZero:includesActualByteCount:) instead of explicitly using this initializer. This is the case when you call formatted(_:) on a BinaryInteger.

See Also

Creating a byte count style

• ByteCountFormatStyle.Units