Тип: Число. Размер данных в байтах. В некоторых случаях может быть равен нулю. Например, при чтении двоичных данных из конца потока или при разделении данных.
Полное описание, параметры и ограничения
РезультатЧтенияДанных.Размер (ReadDataResult.Size)
РезультатЧтенияДанных (ReadDataResult)
Размер (Size)
Доступен, начиная с версии 8.3.9.
Использование:
Только чтение.
Описание:
Тип: Число.
Размер данных в байтах. В некоторых случаях может быть равен нулю. Например, при чтении двоичных данных из конца потока или при разделении данных.
Доступность:
Тонкий клиент, веб-клиент, сервер, толстый клиент, внешнее соединение.
Использование в версии:
Доступен, начиная с версии 8.3.9.
Методическая информация
Практические примеры
Собрать пакет с версией, количеством и UTF-8 названием
Пакет имеет согласованную структуру: 1 байт версии, 2 байта количества, 4 байта длины названия, затем UTF-8. Проверяем поля до чтения тела.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Серверный контекст, только память. Это учебный протокол, не формат какого-либо реального API.
Название кодируется в UTF-8 без BOM; целые записываются в LittleEndian.
В конструктор записи и чтения передаётся уже созданный поток: его закрываем отдельно после закрытия обоих объектов.
Название = ПолучитьБуферДвоичныхДанныхИзСтроки("Книга", КодировкаТекста.UTF8, Ложь);
Поток = Новый ПотокВПамяти;
Попытка
Запись = Новый ЗаписьДанных(Поток, КодировкаТекста.UTF8, ПорядокБайтов.LittleEndian);
Попытка
Запись.ЗаписатьБайт(1);
Запись.ЗаписатьЦелое16(3);
Запись.ЗаписатьЦелое32(Название.Размер);
Запись.ЗаписатьБуферДвоичныхДанных(Название);
Исключение
Запись.Закрыть();
ВызватьИсключение;
КонецПопытки;
Запись.Закрыть();
Сообщить(Поток.Размер());
Поток.Перейти(0, ПозицияВПотоке.Начало);
Чтение = Новый ЧтениеДанных(Поток, КодировкаТекста.UTF8, ПорядокБайтов.LittleEndian);
Попытка
Версия = Чтение.ПрочитатьБайт();
Если Версия <> 1 Тогда
ВызватьИсключение "Неподдерживаемая версия пакета";
КонецЕсли;
Количество = Чтение.ПрочитатьЦелое16();
Длина = Чтение.ПрочитатьЦелое32();
Если Количество = Неопределено Или Длина = Неопределено Тогда
ВызватьИсключение "Заголовок пакета оборван";
КонецЕсли;
Если Длина < 0 Или Длина > 1024 Тогда
ВызватьИсключение "Недопустимая длина названия";
КонецЕсли;
Результат = Чтение.Прочитать(Длина);
Если Результат.Размер <> Длина Тогда
ВызватьИсключение "Название получено не полностью";
КонецЕсли;
БуферНазвания = Результат.ПолучитьБуферДвоичныхДанных();
Сообщить(ПолучитьСтрокуИзБуфераДвоичныхДанных(БуферНазвания, КодировкаТекста.UTF8));
Сообщить(Количество);
Сообщить(Результат.ПолучитьДвоичныеДанные().Размер());
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
Чтение.Закрыть();
Исключение
Поток.Закрыть();
ВызватьИсключение;
КонецПопытки;
Поток.Закрыть();Разбор по шагам
Записываем поля заголовка в фиксированном порядке и длину тела в байтах.
Закрыть объекта записи сбрасывает её буферы, не закрывая переданный извне поток.
Возвращаем позицию в начало и читаем поля в том же порядке и с тем же порядком байтов.
Ограничиваем длину, проверяем фактический размер прочитанного тела и лишь затем декодируем название.
Как проверить результат
Размер пакета 17 байтов: 1 + 2 + 4 + 10; результат Книга и количество 3.
Замените записанную версию 1 на 2: чтение должно завершиться текстом Неподдерживаемая версия пакета.
Укажите при записи длину 100 вместо фактических 10: должна сработать проверка неполного названия.
Ожидаемый результат
Пакет прочитан с проверкой версии, ограничением размера и контролем неполного тела.
На что обратить внимание
Для сетевого потока частичное чтение может быть нормальным: в реальном сетевом протоколе собирайте тело циклом до нужного размера или завершения потока.
Нельзя доверять длине из внешнего пакета без верхнего ограничения: иначе можно выделить чрезмерную память.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Асинхронно прочитать часть, преобразовать результат и переписать его в поток
Читаем ABC из ABCDE. Результат обещания чтения ещё не является буфером: отдельно ожидаем получение буфера и двоичных данных.
Где и как запускать
Модуль пустой управляемой формы учебной внешней обработки; тонкий или толстый клиент Windows. Вставьте весь модуль. Это не серверный код.
Подготовка
Создайте учебную внешнюю обработку с пустой управляемой основной формой. Создайте команду УчебныйПример и кнопку этой команды.
В свойстве команды Действие выберите процедуру УчебныйПример. Вставьте полный приведённый модуль формы.
Откройте EPF в тонком или толстом клиенте Windows и нажмите кнопку. Не переносите Ждать и Асинх в серверный общий модуль.
Пример работает только со своими данными в памяти; записи в базу, файлы и сеть нет.
&НаКлиенте
Асинх Процедура УчебныйПример(Команда)
Данные = ПолучитьДвоичныеДанныеИзСтроки("ABCDE", КодировкаТекста.UTF8, Ложь);
Чтение = Новый ЧтениеДанных(Данные);
Попытка
Часть = Ждать Чтение.ПрочитатьАсинх(3);
Буфер = Ждать Часть.ПолучитьБуферДвоичныхДанныхАсинх();
Двоичные = Ждать Часть.ПолучитьДвоичныеДанныеАсинх();
Сообщить(Часть.Размер = 3 И Буфер.Размер = 3 И Двоичные.Размер() = 3);
Сообщить(ПолучитьСтрокуИзБуфераДвоичныхДанных(Буфер, КодировкаТекста.UTF8) = "ABC");
Сообщить(ПолучитьСтрокуИзДвоичныхДанных(Двоичные, КодировкаТекста.UTF8) = "ABC");
Ждать Чтение.ЗакрытьАсинх();
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
Поток = Новый ПотокВПамяти;
Запись = Новый ЗаписьДанных(Поток);
Попытка
Ждать Запись.ЗаписатьАсинх(Часть);
Ждать Запись.ЗакрытьАсинх();
Исключение
Запись.Закрыть();
Поток.Закрыть();
ВызватьИсключение;
КонецПопытки;
Копия = Поток.ЗакрытьИПолучитьДвоичныеДанные();
Сообщить(ПолучитьСтрокуИзДвоичныхДанных(Копия, КодировкаТекста.UTF8) = "ABC");
КонецПроцедурыРазбор по шагам
Ждать ПрочитатьАсинх(3) даёт РезультатЧтенияДанных с тремя байтами, а не строку ABC.
ПолучитьБуферДвоичныхДанныхАсинх и ПолучитьДвоичныеДанныеАсинх — отдельные операции с собственными обещаниями.
Проверяем размер и содержимое обоих представлений. Для маленького упражнения получение обоих безопасно.
ЗаписатьАсинх принимает сам результат чтения. В новый поток попадает ABC, не весь исходный ABCDE.
Закрываем оболочку записи до извлечения результата из своего потока.
Как проверить результат
Часть, буфер и двоичные данные имеют размер 3; все четыре сообщения Истина.
В восстановленной копии только ABC, букв DE нет.
Ожидаемый результат
Различены Обещание, РезультатЧтенияДанных, БуферДвоичныхДанных и ДвоичныеДанные.
На что обратить внимание
Получение полного буфера загружает часть в память. Не повторяйте оба преобразования для огромного результата без нужды.
Ждать не преобразует двоичные данные в текст автоматически: декодирование UTF-8 выполняется явно.
После закрытия чтения не пытайтесь прочитать оставшиеся DE этим экземпляром.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.