Struct ObservableCollectionExtended 

pub struct ObservableCollectionExtended<T> { /* private fields */ }

An observable collection with ranges, loads and suspended notifications (ObservableCollectionExtended<T>), the collection that the binding operators fill.

It is a shared handle over an ObservableCollection<T> (the base class upstream), which items controls read and observe: collection is that collection. The changes made through this handle raise the notifications of the base, except those that are suspended (upstream’s overrides of OnCollectionChanged and OnPropertyChanged).

Deviation (DEVIATIONS.md, DynamicData): a subclass of .NET intercepts the notifications of every change; here the changes made through collection directly are not suspended.

Implementations

impl<T: Clone + PartialEq + 'static> ObservableCollectionExtended<T>

pub fn new() -> Self

An empty collection (ObservableCollectionExtended()).

pub fn with_capacity(capacity: usize) -> Self

An empty collection that has room for capacity items (ObservableCollectionExtended(new List<T>(capacity))).

pub fn from_items(items: Vec<T>) -> Self

A collection of the items (ObservableCollectionExtended(IEnumerable<T>), ObservableCollectionExtended(List<T>)).

pub fn collection(&self) -> &ObservableCollection<T>

The observable collection of the items (the base class upstream).

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

Whether self and other are the same collection.

pub fn add_collection_changed( &self, handler: Rc<CollectionChangedHandler<T>>, ) -> u64

Adds a handler of the typed change notifications; returns the token that removes it (CollectionChanged +=).

pub fn remove_collection_changed(&self, token: u64) -> bool

Removes a handler (CollectionChanged -=).

pub fn count(&self) -> usize

The number of items (Count).

pub fn is_empty(&self) -> bool

pub fn get(&self, index: usize) -> T

The item at index (the indexer’s getter).

pub fn items(&self) -> Ref<'_, Vec<T>>

The items, borrowed.

pub fn to_vec(&self) -> Vec<T>

A copy of the items.

pub fn contains(&self, item: &T) -> bool

Whether the collection has item (Contains).

pub fn index_of(&self, item: &T) -> Option<usize>

The index of item (IndexOf).

pub fn add(&self, item: T)

Adds an item at the end (Add).

pub fn insert(&self, index: usize, item: T)

Inserts an item (InsertItem).

pub fn set(&self, index: usize, item: T)

Replaces the item at index (the indexer’s setter, SetItem).

pub fn remove_at(&self, index: usize)

Removes the item at index (RemoveItem).

pub fn remove(&self, item: &T) -> bool

Removes item; false when it is not there (Remove).

pub fn move_item(&self, old_index: usize, new_index: usize)

Moves the item at old_index to new_index (Move, MoveItem).

pub fn clear(&self)

Removes every item (ClearItems): a reset.

pub fn add_range(&self, items: impl IntoIterator<Item = T>)

Adds the items at the end, one at a time (AddRange).

pub fn insert_range(&self, items: impl IntoIterator<Item = T>, index: usize)

Inserts the items from index, one at a time (InsertRange).

pub fn load(&self, items: impl IntoIterator<Item = T>)

Clears the collection and adds the items (Load).

pub fn remove_range(&self, index: usize, count: usize)

Removes count items from index, one at a time (RemoveRange).

pub fn suspend_count(&self) -> Rc<dyn IDisposable>

Holds back the notifications of Count until the handle is disposed, which raises Count once if it changed (SuspendCount).

pub fn suspend_notifications(&self) -> Rc<dyn IDisposable>

Holds back the notifications of changes and of Count until the handle is disposed, which raises Count and a reset (SuspendNotifications).

pub fn on_property_changed(&self, name: &str)

Raises PropertyChanged, unless it is Count and the count is suspended (OnPropertyChanged).

pub fn on_collection_changed( &self, action: NotifyCollectionChangedAction, new_items: &[T], old_items: &[T], new_starting_index: i32, old_starting_index: i32, )

Raises CollectionChanged, unless the notifications are suspended (OnCollectionChanged).

Trait Implementations

impl<T> Clone for ObservableCollectionExtended<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + PartialEq + Debug + 'static> Debug for ObservableCollectionExtended<T>

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

Formats the value using the given formatter.

impl<T: Clone + PartialEq + 'static> Default for ObservableCollectionExtended<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Clone + PartialEq + 'static> From<&ObservableCollectionExtended<T>> for ReadOnlyObservableCollection<T>

fn from(collection: &ObservableCollectionExtended<T>) -> Self

The view of the collection (new ReadOnlyObservableCollection<T>(observableCollectionExtended)).

impl<T: Clone + PartialEq + 'static> IExtendedList<T> for ObservableCollectionExtended<T>

fn insert_range(&mut self, items: Vec<T>, index: usize)

Inserts the items at index (InsertRange).

fn move_index(&mut self, original: usize, destination: usize)

Moves the item at original to destination (Move(int, int)).

impl<T: Clone + PartialEq + 'static> IList<T> for ObservableCollectionExtended<T>

The collection as a list of DynamicData (IList<T>, IExtendedList<T>): what ListEx and SortAndBind apply changes to.

fn count(&self) -> usize

The number of items (Count).

fn get(&self, index: usize) -> T

The item at index (the indexer’s getter).

fn set(&mut self, index: usize, item: T)

Replaces the item at index (the indexer’s setter).

fn insert(&mut self, index: usize, item: T)

Inserts an item (Insert).

fn remove_at(&mut self, index: usize)

Removes the item at index (RemoveAt).

fn clear(&mut self)

Removes every item (Clear).

fn add(&mut self, item: T)

Adds an item at the end (Add).

fn index_of(&self, item: &T) -> Option<usize>

The index of item (IndexOf).

fn remove(&mut self, item: &T) -> bool

Removes item; false when it is not in the list (Remove).

fn add_range(&mut self, items: Vec<T>)

Adds the items at the end (ListEx.AddRange): one by one unless the list adds ranges.

fn add_or_insert_range(&mut self, items: Vec<T>, index: Option<usize>)

Inserts the items at index, or adds them without an index (ListEx.AddOrInsertRange): in reverse order at the index unless the list inserts ranges, as upstream does.

fn remove_range(&mut self, index: usize, count: usize)

Removes count items from index (ListEx.RemoveRange).

fn supports_ranges(&self) -> bool

Whether the list removes ranges at once (List<T> or IExtendedList<T>).

fn move_item(&mut self, original: usize, destination: usize)

Moves the item at original to destination (the Moved case of ListEx.Clone).

fn index_of_with( &self, item: &T, comparer: &dyn Fn(&T, &T) -> bool, ) -> Option<usize>

The index of item by comparer (ListEx.IndexOf(IEnumerable, T, IEqualityComparer)).

fn refresh_at(&mut self, index: usize, item: T)

Reports a refresh of the item at index (the Refresh case of ListEx.Clone): the item is removed and inserted again unless the list reports refreshes.

impl<T> INotifyCollectionChanged for ObservableCollectionExtended<T>

fn collection_changed(&self) -> &Event<CollectionChange>

The event raised when the collection changes.

impl<T: Clone + PartialEq + 'static> INotifyCollectionChangedSuspender for ObservableCollectionExtended<T>

fn suspend_count(&self) -> Rc<dyn IDisposable>

Holds back the notifications of Count until the handle is disposed, which raises Count once if it changed (SuspendCount).

fn suspend_notifications(&self) -> Rc<dyn IDisposable>

Holds back the notifications of changes and of Count until the handle is disposed, which raises Count and a reset (SuspendNotifications).

impl<T> INotifyPropertyChanged for ObservableCollectionExtended<T>

fn property_changed(&self) -> &Event<str>

The event raised when a property value changes.

fn as_notify_property_changing(&self) -> Option<&dyn INotifyPropertyChanging>

The object as INotifyPropertyChanging, when it also raises the event of a property that is about to change; None by default.

impl<T: Clone + PartialEq + 'static> IObservableCollection<T> for ObservableCollectionExtended<T>

fn clone_changes(&self, changes: &ChangeSet<T>)

The changes applied as to an IExtendedList<T> (ranges at once).

fn count(&self) -> usize

The number of items (Count).

fn get(&self, index: usize) -> T

The item at index (the indexer’s getter).

fn set(&self, index: usize, item: T)

Replaces the item at index (the indexer’s setter).

fn insert(&self, index: usize, item: T)

Inserts an item (Insert).

fn remove_at(&self, index: usize)

Removes the item at index (RemoveAt).

fn clear(&self)

Removes every item (Clear).

fn to_vec(&self) -> Vec<T>

A copy of the items.

fn add(&self, item: T)

Adds an item at the end (Add).

fn index_of(&self, item: &T) -> Option<usize>

The index of item (IndexOf).

fn remove(&self, item: &T) -> bool

Removes item; false when it is not there (Remove).

fn load(&self, items: Vec<T>)

Clears the collection and adds the items (Load).

fn move_item(&self, old_index: usize, new_index: usize)

Moves the item at old_index to new_index (Move).

fn contains(&self, item: &T) -> bool

Whether the collection has item (Contains).

impl<T: Clone + PartialEq + 'static> ObservableCollectionEx<T> for ObservableCollectionExtended<T>

fn notifying_collection(&self) -> ObservableCollection<T>

The observable collection whose changes are observed.

fn observe_collection_changes( &self, ) -> Rc<dyn IObservable<CollectionChangedEventPattern<T>>>

The notifications of the changes of the collection (ObserveCollectionChanges).

fn to_observable_change_set(&self) -> Rc<dyn IObservable<ChangeSet<T>>>

The items of the collection as change sets of a list: its items first, then each of its changes (ToObservableChangeSet<T>(), ToObservableChangeSet<TCollection, T>()).

fn to_observable_change_set_with_key<K: Eq + Hash + Clone + 'static>( &self, key_selector: impl Fn(&T) -> K + 'static, ) -> Rc<dyn IObservable<ChangeSet<T, K>>>

to_observable_change_set with each item keyed by key_selector (ToObservableChangeSet<TObject, TKey>(Func<TObject, TKey>)).

impl<T> PartialEq for ObservableCollectionExtended<T>

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

The same collection (reference equality).

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

Inequality operator !=.