Struct DatePickerState 

pub struct DatePickerState {
    pub selected: Option<MaterialDate>,
    pub displayed_month: MaterialDate,
    pub mode: DatePickerMode,
    pub entry_mode: DatePickerEntryMode,
    pub input_text: String,
}

The date picker’s whole controlled state: what is selected, which month and sub-view the calendar shows, which entry mode the dialog is in, and the input field’s draft text.

Held by the app, never by a widget — see the module docs’ controlled note. Every with_*/stepped_*/toggled_* method below returns a new value rather than mutating, which is exactly the shape a widget’s on_change callback reports and an app’s handler assigns.

Fields

selected: Option<MaterialDate>

The picked date, or None if nothing is picked yet.

displayed_month: MaterialDate

The month the day grid shows, normalized to its 1st.

mode: DatePickerMode

Which calendar sub-view is showing.

entry_mode: DatePickerEntryMode

Which entry mode the dialog is in (ignored by a bare calendar_date_picker, which is always a calendar).

input_text: String

The input field’s current text. Kept in sync with Self::selected by Self::with_selected, and free-form while the user types.

Implementations

impl DatePickerState

pub fn new(initial: Option<MaterialDate>, today: MaterialDate) -> Self

A fresh state: initial selected (or nothing), showing that date’s month — or today’s if nothing is selected — in the day sub-view and the calendar entry mode.

Mirrors _M3ECalendarDatePickerState.initState’s base = _selectedDate ?? _currentDate; _displayedMonth = getMonth(base).

pub fn with_selected(&self, date: MaterialDate) -> Self

This state with selected picked: the date recorded, the displayed month moved onto it, and Self::input_text refreshed to its compact form so a later switch into input mode shows the picked date (the reference’s _updateValueForSelectedDate).

pub fn with_displayed_month(&self, month: MaterialDate) -> Self

This state with the displayed month replaced (normalized to its 1st). The selection is untouched — paging past the selected month keeps it selected, exactly as the reference’s PageView does.

pub fn stepped_month( &self, delta: i32, first: MaterialDate, last: MaterialDate, ) -> Self

This state paged delta months, clamped so the displayed month never leaves first..=last’s own months — the reference’s page-count bound (page > 0 / page < _monthCount - 1).

pub fn can_step_month( &self, delta: i32, first: MaterialDate, last: MaterialDate, ) -> bool

Whether paging by delta would actually move — what the prev/next affordances enable off.

pub fn with_mode(&self, mode: DatePickerMode) -> Self

This state showing calendar sub-view mode.

pub fn toggled_mode(&self) -> Self

This state with the calendar sub-view toggled (day ⇄ year) — what the sub-header’s month/year label reports.

pub fn with_entry_mode(&self, entry_mode: DatePickerEntryMode) -> Self

This state in entry mode entry_mode.

pub fn toggled_entry_mode(&self) -> Self

This state with the entry mode toggled (calendar ⇄ input), preserving the selection and its formatted text — the reference’s _handleEntryModeToggle, whose _formKey.currentState?.save() on the way out of input mode exists for exactly this round trip.

A locked (*Only) entry mode reports itself unchanged.

pub fn with_input_text(&self, text: impl Into<String>) -> Self

This state with the input field’s draft text replaced. The selection is not touched — a widget parses the text itself and calls Self::with_selected separately once it resolves to a selectable date, mirroring the reference’s split between onChanged (field.didChange) and onDateSubmitted/onDateSaved.

pub fn year_candidate( &self, year: i32, first: MaterialDate, last: MaterialDate, ) -> MaterialDate

The date a tap on year cell year would select, before any selectability predicate: the current selection’s month/day carried onto year (shortened where that month is shorter) and clamped into first..=last — the reference’s _buildYearCell candidate.

pub fn with_year( &self, year: i32, first: MaterialDate, last: MaterialDate, ) -> Self

This state after a tap on year cell year: back to the day sub-view, showing (and selecting) Self::year_candidate — the reference’s _handleYearChanged.

A caller with a selectability predicate checks Self::year_candidate first and falls back to self.with_displayed_month(..).with_mode(Day) when the candidate is refused, which is what the reference’s if (isSelectable(clamped)) guard does.

Trait Implementations

impl Clone for DatePickerState

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatePickerState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for DatePickerState

impl PartialEq for DatePickerState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DatePickerState