possible_free_space Property
The maximum amount of free space the vault could possibly have available.
Syntax
def get_possible_free_space() -> int: ...
possible_free_space = property(get_possible_free_space, None)
Default Value
0
Remarks
This property reflects the maximum amount of free space, in bytes, that the vault could possibly have available. That is, the amount of free space that would be available if the vault automatically grew to its maximum possible_size right now, without any additional data being written to it. Therefore:
- If vault_size_max is 0 (unlimited): this property is equivalent to vault_free_space + parent_free_space.
- If vault_size_max is not 0: this property is equivalent to vault_free_space + min(parent_free_space, (vault_size_max - vault_size)).
In both cases, parent_free_space is the amount of free space available for the vault to use for automatic growth. For a file-based vault, this is the total amount of free space on the disk where the vault's storage file (i.e., vault_file) resides, as reported by the OS. For a Callback Mode vault, this is whatever value the application provides via the on_vault_get_parent_size event.
Please refer to the Vault Size topic for more information.
This property is read-only.