Class Segment

python/binaryview.py:1398–1509

The ``Segment`` object is returned during BinaryView creation and should not be directly instantiated.

class Segment:
	"""
	The ``Segment`` object is returned during BinaryView creation and should not be directly instantiated.
	"""
	def __init__(self, handle: core.BNSegmentHandle):
		self.handle = handle

	def __del__(self):
		if core is not None:
			core.BNFreeSegment(self.handle)

	def __repr__(self):
		r = "r" if self.readable else "-"
		w = "w" if self.writable else "-"
		x = "x" if self.executable else "-"
		return f"<segment: {self.start:#x}-{self.end:#x}, {r}{w}{x}>"

	@classmethod
	@deprecation.deprecated(deprecated_in="4.3.6653", details="Use `SegmentDescriptorList` instead.")
	def serialize(cls, image_base: int, start: int, length: int, data_offset: int=0, data_length: int=0, flags: 'SegmentFlag'=SegmentFlag.SegmentReadable, auto_defined=True, segments: str="[]"):
		"""
		Serialize segment parameters into a JSON string. This is useful for generating a properly formatted segment description as options when using `load`.

		:param int image_base: The base address of the image.
		:param int start: The start address of the segment.
		:param int length: The length of the segment.
		:param int data_offset: The offset of the data within the segment.
		:param int data_length: The length of the data within the segment.
		:param SegmentFlag flags: The flags of the segment.
		:param bool auto_defined: Whether the segment is auto-defined.
		:param str segments: An optional, existing array of segments to append to.
		:return: A JSON string representing the segment.
		:rtype: str

		:Example::
			>>> base = 0x400000
			>>> rom_base = 0xffff0000
			>>> segments = SegmentDescriptorList(base)
			>>> segments.append(start=base, length=0x1000, data_offset=0, data_length=0x1000, flags=SegmentFlag.SegmentReadable|SegmentFlag.SegmentExecutable)
			>>> segments.append(start=rom_base, length=0x1000, flags=SegmentFlag.SegmentReadable)
			>>> view = load(bytes.fromhex('5054ebfe'), options={'loader.imageBase': base, 'loader.platform': 'x86', 'loader.segments': json.dumps(segments)})
		"""
		segments_list = json.loads(segments)
		segment_info = {
			"auto_defined": auto_defined,
			"data_length": data_length,
			"data_offset": data_offset,
			"flags": flags,
			"length": length,
			"start": start - image_base
		}
		segments_list.append(segment_info)
		return json.dumps(segments_list)

	@property
	def length(self):
		return int(core.BNSegmentGetLength(self.handle))