diff options
Diffstat (limited to 'components/net_traits/storage_task.rs')
-rw-r--r-- | components/net_traits/storage_task.rs | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/components/net_traits/storage_task.rs b/components/net_traits/storage_task.rs new file mode 100644 index 00000000000..cedc98bf480 --- /dev/null +++ b/components/net_traits/storage_task.rs @@ -0,0 +1,44 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +use std::sync::mpsc::Sender; +use url::Url; + +use util::str::DOMString; + +#[derive(Copy)] +pub enum StorageType { + Session, + Local +} + +/// Request operations on the storage data associated with a particular url +pub enum StorageTaskMsg { + /// gets the number of key/value pairs present in the associated storage data + Length(Sender<u32>, Url, StorageType), + + /// gets the name of the key at the specified index in the associated storage data + Key(Sender<Option<DOMString>>, Url, StorageType, u32), + + /// gets the value associated with the given key in the associated storage data + GetItem(Sender<Option<DOMString>>, Url, StorageType, DOMString), + + /// sets the value of the given key in the associated storage data + /// TODO throw QuotaExceededError in case of error + SetItem(Sender<(bool, Option<DOMString>)>, Url, StorageType, DOMString, DOMString), + + /// removes the key/value pair for the given key in the associated storage data + RemoveItem(Sender<Option<DOMString>>, Url, StorageType, DOMString), + + /// clears the associated storage data by removing all the key/value pairs + Clear(Sender<bool>, Url, StorageType), + + /// shut down this task + Exit +} + +/// Handle to a storage task +pub type StorageTask = Sender<StorageTaskMsg>; + + |