b.s.v.VfsRequest(request.SmartServerRequest) : class documentation

Part of bzrlib.smart.vfs View In Hierarchy

Known subclasses: bzrlib.smart.vfs.AppendRequest, bzrlib.smart.vfs.DeleteRequest, bzrlib.smart.vfs.GetRequest, bzrlib.smart.vfs.HasRequest, bzrlib.smart.vfs.IterFilesRecursiveRequest, bzrlib.smart.vfs.ListDirRequest, bzrlib.smart.vfs.MkdirRequest, bzrlib.smart.vfs.MoveRequest, bzrlib.smart.vfs.PutNonAtomicRequest, bzrlib.smart.vfs.PutRequest, bzrlib.smart.vfs.ReadvRequest, bzrlib.smart.vfs.RenameRequest, bzrlib.smart.vfs.RmdirRequest, bzrlib.smart.vfs.StatRequest

Base class for VFS requests.

VFS requests are disabled if vfs_enabled() returns False.

Method translate_client_path Translate a path received from a network client into a local
Method _check_enabled Raises DisabledMethod if this method is disabled.

Inherited from SmartServerRequest:

Method __init__ Constructor.
Method do Mandatory extension point for SmartServerRequest subclasses.
Method execute Public entry point to execute this request.
Method do_body Called if the client sends a body with the request.
Method do_chunk Called with each body chunk if the request has a streamed body.
Method do_end Called when the end of the request has been received.
Method setup_jail Undocumented
Method teardown_jail Undocumented
Method transport_from_client_path Get a backing transport corresponding to the location referred to by
def _check_enabled(self):
Raises DisabledMethod if this method is disabled.
def translate_client_path(self, relpath):
Translate a path received from a network client into a local relpath.

All paths received from the client must be translated.

Parametersclient_paththe path from the client.
Returnsa relpath that may be used with self._backing_transport (unlike the untranslated client_path, which must not be used with the backing transport).
API Documentation for Bazaar, generated by pydoctor at 2019-11-11 00:34:53.