From 2b588340af501825f3ab03f2e76dba0353c98fae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 4 Jun 2018 12:59:26 +0200 Subject: Update documentation for Gun 1.0 --- docs/en/gun/1.0/manual/gun.patch/index.html | 294 ++++++++++++++++++++++++++++ 1 file changed, 294 insertions(+) create mode 100644 docs/en/gun/1.0/manual/gun.patch/index.html (limited to 'docs/en/gun/1.0/manual/gun.patch/index.html') diff --git a/docs/en/gun/1.0/manual/gun.patch/index.html b/docs/en/gun/1.0/manual/gun.patch/index.html new file mode 100644 index 00000000..54ab78b4 --- /dev/null +++ b/docs/en/gun/1.0/manual/gun.patch/index.html @@ -0,0 +1,294 @@ + + + + + + + + + + Nine Nines: gun:patch(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

gun:patch(3)

+ +
+

Name

+
+

gun:patch - Apply a set of changes to a resource

+
+
+
+

Description

+
+
+
+
patch(ConnPid, Path, Headers)
+    -> StreamRef
+
+patch(ConnPid, Path, Headers, Body)
+    -> patch(ConnPid, Path, Headers, Body, #{})
+
+patch(ConnPid, Path, Headers, Body, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+Body      :: iodata()
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
+

Apply a set of changes to a resource.

+

The behavior of this function varies depending on whether +a body is provided.

+

The function patch/3 expects either a content-length +or content-type header to indicate that a body will be +sent afterwards. The body can then be sent using +gun:data(3).

+

The function patch/4,5 sends the entire request, including +the request body, immediately. It is therefore not possible +to use gun:data(3) after that. You +should provide a content-type header. Gun will set the +content-length header automatically.

+

The body sent in this request should be a patch document +with instructions on how to update the resource.

+
+
+
+

Arguments

+
+
+
+ConnPid +
+
+

+The pid of the Gun connection process. +

+
+
+Path +
+
+

+Path to the resource. +

+
+
+Headers +
+
+

+Additional request headers. +

+
+
+Body +
+
+

+Request body. +

+
+
+ReqOpts +
+
+

+Request options. +

+
+
+
+
+
+

Return value

+
+

A reference that identifies the newly created stream is +returned. It is this reference that must be passed in +subsequent calls and will be received in messages related +to this new stream.

+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Patch a resource
+
+
StreamRef = gun:patch(ConnPid, "/users/1",
+    [{<<"content-type">>, <<"application/json-patch+json">>}],
+    <<"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]">>).
+
+
Patch a resource in multiple calls
+
+
StreamRef = gun:patch(ConnPid, "/users/1", [
+    {<<"content-type">>, <<"application/json-patch+json">>}
+]).
+gun:data(ConnPid, StreamRef, fin,
+    <<"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]">>).
+
+
Patch a resource with request options
+
+
StreamRef = gun:patch(ConnPid, "/users/1",
+    [{<<"content-type">>, <<"application/json-patch+json">>}],
+    <<"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]">>,
+    #{reply_to => ReplyToPid}).
+
+
+
+

See also

+
+

gun(3), +gun:post(3), +gun:put(3), +gun:await(3), +gun:await_body(3), +gun_push(3), +gun_inform(3), +gun_response(3), +gun_data(3)

+
+
+ + + + + +
+ +
+ + +

+ Gun + 1.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 1.0
    • + +
+ +
+
+
+
+ + + + + + + + + -- cgit v1.2.3