[#BloombergLP-bdlt-DayOfWeek]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::DayOfWeek
:relfileprefix: ../../
:mrdocs:

This `struct` provides a namespace for enumerating day&hyphen;of&hyphen;week values&period; See `Enum` in the TYPES sub&hyphen;section for details&period;

== Synopsis

Declared in `&lt;bdlt&lowbar;dayofweek&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct DayOfWeek;
----

== Description

This `struct`&colon; &ast; supports a complete set of _enumeration_ operations For terminology see `bsldoc&lowbar;glossary`&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeek/Day.adoc[`Day`] 
| Deprecated alias for `Enum`&period;
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeek/Enum.adoc[`Enum`] 
| Enumerated day&hyphen;of&hyphen;week values&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DayOfWeek/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to the specified `variable` the value read from the specified input `stream` using the specified `version` format, and return a reference to `stream`&period; If `stream` is initially invalid, this operation has no effect&period; If `version` is not supported, `variable` is unaltered and `stream` is invalidated, but otherwise unmodified&period; If `version` is supported but `stream` becomes invalid during this operation, `variable` has an undefined, but valid, state&period; Note that no version is read from `stream`&period; See the `bslx` package&hyphen;level documentation for more information on BDEX streaming of value&hyphen;semantic types and containers&period;
| xref:BloombergLP/bdlt/DayOfWeek/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write the value of the specified `value`, using the specified `version` format, to the specified output `stream`, and return a reference to `stream`&period; If `stream` is initially invalid, this operation has no effect&period; If `version` is not supported, `stream` is invalidated, but otherwise unmodified&period; Note that `version` is not written to `stream`&period; See the `bslx` package&hyphen;level documentation for more information on BDEX streaming of value&hyphen;semantic types and containers&period;
| xref:BloombergLP/bdlt/DayOfWeek/maxSupportedBdexVersion-00.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
| xref:BloombergLP/bdlt/DayOfWeek/print.adoc[`print`] 
| Write the string representation of the specified enumeration `value` to the specified output `stream`, and return a reference to `stream`&period; Optionally specify an initial indentation `level`, whose absolute value is incremented recursively for nested objects&period; If `level` is specified, optionally specify `spacesPerLevel`, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects&period; If `level` is negative, suppress indentation of the first line&period; If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`)&period; The behavior is undefined unless `dayOfWeek` is in the range `&lsqb; e&lowbar;SUN &period;&period; e&lowbar;SAT &rsqb;`&period; See `toAscii` for what constitutes the string representation of a `bdlt&colon;&colon;DayOfWeek&colon;&colon;Enum` value&period;
| xref:BloombergLP/bdlt/DayOfWeek/toAscii.adoc[`toAscii`] 
| Return the abbreviated character&hyphen;string representation of the enumerator corresponding to the specified `dayOfWeek`&period; This representation matches the enumerator&apos;s three&hyphen;character name (e&period;g&period;, `e&lowbar;SUN`) with the &quot;e&lowbar;&quot; prefix elided&period; For example&colon; &grave; bsl&colon;&colon;cout &lt;&lt; bdlt&colon;&colon;DayOfWeek&colon;&colon;toAscii(bdlt&colon;&colon;DayOfWeek&colon;&colon;e&lowbar;SUN)&semi; &grave; prints the following on standard output&colon; &grave; SUN &grave; Note that specifying a `dayOfWeek` that does not match any of the enumerators will result in an unspecified string representation being returned that is distinct from the values returned for any valid enumeration&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
