Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`spread`.`pb`.`RemoteCopy``

class documentation

`class RemoteCopy(Unjellyable): (source)`

Known subclasses: `twisted.spread.pb.RemoteCache`, `twisted.web.distrib.Request`, `twisted.spread.pb.CopiedFailure`

View In Hierarchy

I am a remote copy of a Copyable object.

When the state from a `Copyable` object is received, an instance will be created based on the copy tags table (see setUnjellyableForClass) and sent the `setCopyableState` message. I provide a reasonable default implementation of that message; subclass me if you wish to serve as a copier for remote data.

NOTE: copiers are invoked with no arguments. Do not implement a constructor which requires args in a subclass of `RemoteCopy`!

Method | `setCopyableState` | I will be invoked with the state to copy locally.
Method | `unjellyFor` | Perform the inverse operation of `Jellyable.jellyFor`.
Instance Variable | `__dict__` | Undocumented

Inherited from `Unjellyable`:

Method | `setStateFor` | Undocumented

def setCopyableState(self, state): (source)
overridden in `twisted.spread.publish.RemotePublished`, `twisted.web.distrib.Request`

I will be invoked with the state to copy locally.

'state' is the data returned from the remote object's 'getStateToCopyFor' method, which will often be the remote object's dictionary (or a filtered approximation of it depending on my peer's perspective).

def unjellyFor(self, unjellier, jellyList): (source)
from `twisted.spread.interfaces.IUnjellyable`
overrides `twisted.spread.jelly.Unjellyable.unjellyFor`
overridden in `twisted.spread.pb.RemoteCache`

Perform the inverse operation of `Jellyable.jellyFor`.

See Also
`twisted.spread.interfaces.IUnjellyable.unjellyFor`

__dict__ = (source)
overrides `twisted.spread.jelly.Unjellyable.__dict__`
overridden in `twisted.spread.pb.RemoteCache`

Undocumented