primo commit

libraries/vendor/symfony/http-client-contracts/ChunkInterface.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Contracts\HttpClient;
+
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+
+/**
+ * The interface of chunks returned by ResponseStreamInterface::current().
+ *
+ * When the chunk is first, last or timeout, the content MUST be empty.
+ * When an unchecked timeout or a network error occurs, a TransportExceptionInterface
+ * MUST be thrown by the destructor unless one was already thrown by another method.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+interface ChunkInterface
+{
+    /**
+     * Tells when the idle timeout has been reached.
+     *
+     * @throws TransportExceptionInterface on a network error
+     */
+    public function isTimeout(): bool;
+
+    /**
+     * Tells when headers just arrived.
+     *
+     * @throws TransportExceptionInterface on a network error or when the idle timeout is reached
+     */
+    public function isFirst(): bool;
+
+    /**
+     * Tells when the body just completed.
+     *
+     * @throws TransportExceptionInterface on a network error or when the idle timeout is reached
+     */
+    public function isLast(): bool;
+
+    /**
+     * Returns a [status code, headers] tuple when a 1xx status code was just received.
+     *
+     * @throws TransportExceptionInterface on a network error or when the idle timeout is reached
+     */
+    public function getInformationalStatus(): ?array;
+
+    /**
+     * Returns the content of the response chunk.
+     *
+     * @throws TransportExceptionInterface on a network error or when the idle timeout is reached
+     */
+    public function getContent(): string;
+
+    /**
+     * Returns the offset of the chunk in the response body.
+     */
+    public function getOffset(): int;
+
+    /**
+     * In case of error, returns the message that describes it.
+     */
+    public function getError(): ?string;
+}