vault_size Property
The actual size of the vault.
Syntax
def get_vault_size() -> int: ... def set_vault_size(value: int) -> None: ...
vault_size = property(get_vault_size, set_vault_size)
Default Value
0
Remarks
This property specifies the actual size of the vault, in bytes.
Applications may use this property to explicitly resize a vault, keeping in mind the following:
- A vault cannot shrink more than its available free space allows (i.e., not by more than vault_free_space bytes).
- A vault cannot shrink beyond vault_size_min bytes.
- If vault_size_max is not 0 (unlimited), a vault cannot grow beyond vault_size_max bytes.
- If a vault grows enough to reach/exceed its auto_compact_at threshold, it will automatically shrink again when the next automatic compaction occurs.
Applications can also determine the maximum size a vault could possibly be by querying the possible_size property. Please refer to the Vault Size topic for more information.
Note: This property can only be changed when active is True, and cannot be changed within events.