class documentation

class FileLockContent(bb.Union): (source)

View In Hierarchy

This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar files.FileLockContent.unlocked: Empty type to indicate no lock. :ivar SingleUserLock FileLockContent.single_user: A lock held by a single user.

Class Method single_user Create an instance of this class set to the ``single_user`` tag with value ``val``.
Method get_single_user A lock held by a single user.
Method is_other Check if the union tag is ``other``.
Method is_single_user Check if the union tag is ``single_user``.
Method is_unlocked Check if the union tag is ``unlocked``.
Class Variable other Undocumented
Class Variable unlocked Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def single_user(cls, val): (source)

Create an instance of this class set to the ``single_user`` tag with value ``val``. :param SingleUserLock val: :rtype: FileLockContent

def get_single_user(self): (source)

A lock held by a single user. Only call this if :meth:`is_single_user` is true. :rtype: SingleUserLock

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_single_user(self): (source)

Check if the union tag is ``single_user``. :rtype: bool

def is_unlocked(self): (source)

Check if the union tag is ``unlocked``. :rtype: bool

Undocumented

unlocked = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all: str = (source)

Undocumented